MLCDocumentsGetMemberDocumentParent Method (ConnectionId, SessionId, DocumentId, Int32, Boolean, Boolean) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This method returns the document that would act as parent of a document if it should be in sync with a given master document. Optionally you can ask this method to move the document for you.

Namespace: ContentStudio.Document.MLC
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public string GetMemberDocumentParent(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId masterDocumentId,
	int memberLanguageId,
	bool performMove,
	bool createChild
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
masterDocumentId
Type: ContentStudio.DocumentDocumentId
The master document to
memberLanguageId
Type: SystemInt32
The language of the document to find.
performMove
Type: SystemBoolean
Move the document to the desired place.
createChild
Type: SystemBoolean
Make the moved document a child of its destination. Ignored if PerformMove is false.

Return Value

Type: String
Xml containing the member document and the member parent.
<root>
   <status>0</status>
   <statustext>Success</statustext>
   <memberdocument>3467</memberdocument>
   <memberparent>4567</memberparent>
</root>
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
  • 1001 - The SessionID is invalid.
  • 1002 - Permission denied.
  • 1009 - Invalid parameter value.
  • 1100 - The document does not exist.
  • 1551 - The language is not valid.
  • 1559 - The document is not an MLC master document.
  • 1561 - The language does not exist in the specified MLC..
  • 1563 - No connected document exists for the specified language.
  • 1564 - No valid MLC parent document exists for the specified member document.
  • 1804 - The document could be found.
  • 1831 - Can not move a root document.
  • 1832 - Can not move. Destination element is a child to the source element.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

If PerformMove is not requested the caller needs READ permission on both the Master and the member document. The caller needs DELETE permission on the affected member document and CREATE permission on the new member parent document in order to perform the move.
See Also

Reference