Skip navigation links

com.stellent.cis.client.api.scs.component.folder
Interface ISCSComponentFolderAPI

All Superinterfaces:

ICommandAPI

public interface ISCSComponentFolderAPI

extends ICommandAPI

The command API implementation of the component.folder commands. This implementation can be accessed directly via the ICommandFacade class, using the API name component.folder, with the following syntax:

 ISCSComponentFolderAPI commandAPI =
       (ISCSComponentFolderAPI)m_commandFacade.getCommandAPI ("component.folder", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSFolder	_createFolder() Create a new empty folder object.
ISCSFolder	_createFolder(java.lang.String folderID) Create a new empty folder object with the given folder ID.
ISCSFolderContent	_createFolderContent() Create a new empty active folder content object
ISCSDocumentCheckinResponse	checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags) Checkin in a file by directly passing the file stream(s).
ISCSDocumentCheckinResponse	checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags) Checkin in a file by directly passing the file stream(s).
ISCSFolderMultiNodeResponse	copyItems(ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Move a folder from one folder to another.
ISCSFolderMultiNodeResponse	copyItems(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Move a folder from one folder to another.
ISCSFolderSingleNodeResponse	createFolder(ISCSContext SCSContext, ISCSFolder folderNode) Create a folder in the folder hierarchy on the content server.
ISCSFolderSingleNodeResponse	createFolder(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolder folderNode) Create a folder in the folder hierarchy on the content server.
ISCSFolderAddLinkResponse	createLink(ISCSContext SCSContext, ISCSFolderID destinationFolderID, ISCSFolderID sourceFolderID, java.lang.String title) Add a link (shortcut) to a given folder
ISCSFolderAddLinkResponse	createLink(ISCSContext SCSContext, ISCSFolderID destinationFolderID, ISCSInternalID sourceContentID, java.lang.String title) Add a link (shortcut) to a given folder
ISCSFolderAddLinkResponse	createLink(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID destinationFolderID, ISCSFolderID sourceFolderID, java.lang.String title) Add a link (shortcut) to a given folder
ISCSFolderAddLinkResponse	createLink(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID destinationFolderID, ISCSInternalID sourceContentID, java.lang.String title) Add a link (shortcut) to a given folder
ISCSFolderDeleteContentResponse	deleteAllContent(ISCSContext SCSContext, ISCSFolderID activeFolderID) Delete all the content residing in a given folder.
ISCSFolderDeleteContentResponse	deleteAllContent(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID activeFolderID) Delete all the content residing in a given folder.
ISCSFolderSingleNodeResponse	deleteFolder(ISCSContext SCSContext, ISCSFolderID folderID) Delete a folder from the folder hierarchy.
ISCSFolderSingleNodeResponse	deleteFolder(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) Delete a folder from the folder hierarchy.
ISCSFolderMultiNodeResponse	deleteItems(ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Delete items from a folder.
ISCSFolderMultiNodeResponse	deleteItems(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Delete items from a folder.
ISCSFolderMultiNodeResponse	emptyTrash(ISCSContext SCSContext, java.util.Collection folderIDs, java.util.Collection itemIDs) Remove items from the trash-can location in the folders hierarchy.
ISCSFolderMultiNodeResponse	emptyTrash(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.util.Collection folderIDs, java.util.Collection itemIDs) Remove items from the trash-can location in the folders hierarchy.
ISCSFolderInfoResponse	getFolder(ISCSContext SCSContext, ISCSFolderID folderID) Retrieve the folder information.
ISCSFolderInfoResponse	getFolder(ISCSContext SCSContext, ISCSFolderPathID folderPathID) Retrieve the folder information.
ISCSFolderInfoResponse	getFolder(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) Retrieve the folder information.
ISCSFolderInfoResponse	getFolder(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderPathID folderPathID) Retrieve the folder information.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSContext SCSContext) Retrieves the complete archived folder structure of the specified folder.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSContext SCSContext, ISCSFolderID folderID) Retrieves the complete archived folder structure of the specified folder.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSContext SCSContext, ISCSFolderPathID folderPathID) Retrieves the complete archived folder structure of the specified folder.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Retrieves the complete archived folder structure of the specified folder.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) Retrieves the complete archived folder structure of the specified folder.
ISCSFolderHierarchyResponse	getFolderHierarchy(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderPathID folderPathID) Retrieves the complete archived folder structure of the specified folder.
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API
ISCSFolderReferenceResponse	getPathInfo(ISCSContext SCSContext, ISCSFolderPathID folderPathID) Get information on the item identified by the path.
ISCSFolderReferenceResponse	getPathInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderPathID folderPathID) Get information on the item identified by the path.
ISCSFolderDisplayResponse	getRootFolder(ISCSContext SCSContext) Get the root of the folder heirachy in the content server.
ISCSFolderDisplayResponse	getRootFolder(ISCSRequestModifier requestModifier, ISCSContext SCSContext) Get the root of the folder heirachy in the content server.
ISCSFolderDisplayResponse	listChildren(ISCSContext SCSContext, ISCSFolderID folderID) List the contents of the given folder.
ISCSFolderDisplayResponse	listChildren(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) List the contents of the given folder.
ISCSFolderListContentsResponse	listContents(ISCSContext SCSContext, ISCSFolderID folderID) List the child folders of a given folder.
ISCSFolderListContentsResponse	listContents(ISCSContext SCSContext, ISCSFolderPathID folderPathID) List the child folders of a given folder.
ISCSFolderListContentsResponse	listContents(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) List the child folders of a given folder.
ISCSFolderListContentsResponse	listContents(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderPathID folderPathID) List the child folders of a given folder.
ISCSFolderListFoldersResponse	listFolders(ISCSContext SCSContext, ISCSFolderID folderID) List the child folders of a given folder.
ISCSFolderListFoldersResponse	listFolders(ISCSContext SCSContext, ISCSFolderPathID folderPathID) List the child folders of a given folder.
ISCSFolderListFoldersResponse	listFolders(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) List the child folders of a given folder.
ISCSFolderListFoldersResponse	listFolders(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderPathID folderPathID) List the child folders of a given folder.
ISCSFolderMultiNodeResponse	moveItems(ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Move a folder from one folder to another.
ISCSFolderMultiNodeResponse	moveItems(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID activeFolderID, java.util.Collection folderIDs, java.util.Collection itemIDs) Move a folder from one folder to another.
ISCSServerResponse	propagateMetadata(ISCSContext SCSContext, ISCSFolderID folderID) Propagates (updates) folder metadata.
ISCSServerResponse	propagateMetadata(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolderID folderID) Propagates (updates) folder metadata.
ISCSFolderSearchResponse	search(ISCSContext SCSContext, java.lang.String queryText, java.lang.String sortOrder, java.lang.String sortKey, int resultCount) Searches the content server for folder nodes.
ISCSFolderSearchResponse	search(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String queryText, java.lang.String sortOrder, java.lang.String sortKey, int resultCount) Searches the content server for folder nodes.
ISCSFolderSingleNodeResponse	updateInfo(ISCSContext SCSContext, ISCSFolder folderNode) Update the metadata information on a given folder object.
ISCSFolderSingleNodeResponse	updateInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSFolder folderNode) Update the metadata information on a given folder object.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

createLink

ISCSFolderAddLinkResponse createLink(ISCSContext SCSContext,
                                     ISCSFolderID destinationFolderID,
                                     ISCSInternalID sourceContentID,
                                     java.lang.String title)
                                     throws CommandException

Add a link (shortcut) to a given folder

Parameters:

SCSContext - the context object representing the current user

destinationFolderID - the destination for the created link

sourceContentID - the source document internal ID

title - the title of the link

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD_LINK"

createLink

ISCSFolderAddLinkResponse createLink(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     ISCSFolderID destinationFolderID,
                                     ISCSInternalID sourceContentID,
                                     java.lang.String title)
                                     throws CommandException

Add a link (shortcut) to a given folder

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

destinationFolderID - the destination for the created link

sourceContentID - the source document internal ID

title - the title of the link

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD_LINK"

createLink

ISCSFolderAddLinkResponse createLink(ISCSContext SCSContext,
                                     ISCSFolderID destinationFolderID,
                                     ISCSFolderID sourceFolderID,
                                     java.lang.String title)
                                     throws CommandException

Add a link (shortcut) to a given folder

Parameters:

SCSContext - the context object representing the current user

destinationFolderID - the destination for the created link

sourceFolderID - the ID of the folder to be linked

title - the title of the link

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD_LINK"

createLink

ISCSFolderAddLinkResponse createLink(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     ISCSFolderID destinationFolderID,
                                     ISCSFolderID sourceFolderID,
                                     java.lang.String title)
                                     throws CommandException

Add a link (shortcut) to a given folder

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

destinationFolderID - the destination for the created link

sourceFolderID - the ID of the folder to be linked

title - the title of the link

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD_LINK"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

checkinFlags - flags that control the checkin operation

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

checkinFlags - flags that control the checkin operation

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

alternateInputStream - the inputstream of the alternate file to be checkin in

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

alternateInputStream - the inputstream of the alternate file to be checkin in

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

alternateInputStream - the inputstream of the alternate file to be checkin in

checkinFlags - flags that control the checkin operation

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException

Checkin in a file by directly passing the file stream(s). This command inherits from parent folder id.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

content - the document node

primaryInputStream - the inputstream of the primary file to be checked in

alternateInputStream - the inputstream of the alternate file to be checkin in

checkinFlags - flags that control the checkin operation

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_CHECKIN_NEW"

createFolder

ISCSFolderSingleNodeResponse createFolder(ISCSContext SCSContext,
                                          ISCSFolder folderNode)
                                          throws CommandException

Create a folder in the folder hierarchy on the content server.

Parameters:

SCSContext - the context object representing the current user

folderNode - the updated folder node

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD"

createFolder

ISCSFolderSingleNodeResponse createFolder(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          ISCSFolder folderNode)
                                          throws CommandException

Create a folder in the folder hierarchy on the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderNode - the updated folder node

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_ADD"

deleteFolder

ISCSFolderSingleNodeResponse deleteFolder(ISCSContext SCSContext,
                                          ISCSFolderID folderID)
                                          throws CommandException

Delete a folder from the folder hierarchy.

Parameters:

SCSContext - the context object representing the current user

folderID - the active folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE"

deleteFolder

ISCSFolderSingleNodeResponse deleteFolder(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          ISCSFolderID folderID)
                                          throws CommandException

Delete a folder from the folder hierarchy.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the active folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE"

deleteAllContent

ISCSFolderDeleteContentResponse deleteAllContent(ISCSContext SCSContext,
                                                 ISCSFolderID activeFolderID)
                                                 throws CommandException

Delete all the content residing in a given folder.

Parameters:

SCSContext - the context object representing the current user

activeFolderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_ALL"

deleteAllContent

ISCSFolderDeleteContentResponse deleteAllContent(ISCSRequestModifier requestModifier,
                                                 ISCSContext SCSContext,
                                                 ISCSFolderID activeFolderID)
                                                 throws CommandException

Delete all the content residing in a given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

activeFolderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_ALL"

deleteItems

ISCSFolderMultiNodeResponse deleteItems(ISCSContext SCSContext,
                                        ISCSFolderID activeFolderID,
                                        java.util.Collection folderIDs,
                                        java.util.Collection itemIDs)
                                        throws CommandException

Delete items from a folder.

Parameters:

SCSContext - the context object representing the current user

activeFolderID - the active folder ID where the items to delete reside

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_LOT"

deleteItems

ISCSFolderMultiNodeResponse deleteItems(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSFolderID activeFolderID,
                                        java.util.Collection folderIDs,
                                        java.util.Collection itemIDs)
                                        throws CommandException

Delete items from a folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

activeFolderID - the active folder ID where the items to delete reside

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_LOT"

emptyTrash

ISCSFolderMultiNodeResponse emptyTrash(ISCSContext SCSContext,
                                       java.util.Collection folderIDs,
                                       java.util.Collection itemIDs)
                                       throws CommandException

Remove items from the trash-can location in the folders hierarchy.

Parameters:

SCSContext - the context object representing the current user

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_LOT"

emptyTrash

ISCSFolderMultiNodeResponse emptyTrash(ISCSRequestModifier requestModifier,
                                       ISCSContext SCSContext,
                                       java.util.Collection folderIDs,
                                       java.util.Collection itemIDs)
                                       throws CommandException

Remove items from the trash-can location in the folders hierarchy.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DELETE_LOT"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSContext SCSContext)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSRequestModifier requestModifier,
                                               ISCSContext SCSContext)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSContext SCSContext,
                                               ISCSFolderID folderID)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSRequestModifier requestModifier,
                                               ISCSContext SCSContext,
                                               ISCSFolderID folderID)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSContext SCSContext,
                                               ISCSFolderPathID folderPathID)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

SCSContext - the context object representing the current user

folderPathID - the folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolderHierarchy

ISCSFolderHierarchyResponse getFolderHierarchy(ISCSRequestModifier requestModifier,
                                               ISCSContext SCSContext,
                                               ISCSFolderPathID folderPathID)
                                               throws CommandException

Retrieves the complete archived folder structure of the specified folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderPathID - the folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_ARCHIVE"

getFolder

ISCSFolderInfoResponse getFolder(ISCSContext SCSContext,
                                 ISCSFolderID folderID)
                                 throws CommandException

Retrieve the folder information. Folder can be identified by either folder ID or by the folder path.

Parameters:

SCSContext - the context object representing the current user

folderID - the active folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_INFO"

getFolder

ISCSFolderInfoResponse getFolder(ISCSRequestModifier requestModifier,
                                 ISCSContext SCSContext,
                                 ISCSFolderID folderID)
                                 throws CommandException

Retrieve the folder information. Folder can be identified by either folder ID or by the folder path.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the active folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_INFO"

getFolder

ISCSFolderInfoResponse getFolder(ISCSContext SCSContext,
                                 ISCSFolderPathID folderPathID)
                                 throws CommandException

Retrieve the folder information. Folder can be identified by either folder ID or by the folder path.

Parameters:

SCSContext - the context object representing the current user

folderPathID - the active folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_INFO"

getFolder

ISCSFolderInfoResponse getFolder(ISCSRequestModifier requestModifier,
                                 ISCSContext SCSContext,
                                 ISCSFolderPathID folderPathID)
                                 throws CommandException

Retrieve the folder information. Folder can be identified by either folder ID or by the folder path.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderPathID - the active folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_INFO"

getPathInfo

ISCSFolderReferenceResponse getPathInfo(ISCSContext SCSContext,
                                        ISCSFolderPathID folderPathID)
                                        throws CommandException

Get information on the item identified by the path. The response will determine what type of item the path being passed in is referencing (Content, or Folder). Links are not supported. If the item is a document, the returned ISCSFolderReferenceResponse will evaluate isContent() == true. If the item is a folder, the response will evaluate isFolder() == true. If neither, it will return null.

Parameters:

SCSContext - the context object representing the current user

folderPathID - the active folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_REFERENCE"

getPathInfo

ISCSFolderReferenceResponse getPathInfo(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSFolderPathID folderPathID)
                                        throws CommandException

Get information on the item identified by the path. The response will determine what type of item the path being passed in is referencing (Content, or Folder). Links are not supported. If the item is a document, the returned ISCSFolderReferenceResponse will evaluate isContent() == true. If the item is a folder, the response will evaluate isFolder() == true. If neither, it will return null.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderPathID - the active folder path ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_GET_REFERENCE"

getRootFolder

ISCSFolderDisplayResponse getRootFolder(ISCSContext SCSContext)
                                        throws CommandException

Get the root of the folder heirachy in the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DISPLAY"

getRootFolder

ISCSFolderDisplayResponse getRootFolder(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext)
                                        throws CommandException

Get the root of the folder heirachy in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DISPLAY"

listChildren

ISCSFolderDisplayResponse listChildren(ISCSContext SCSContext,
                                       ISCSFolderID folderID)
                                       throws CommandException

List the contents of the given folder.

Parameters:

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DISPLAY"

listChildren

ISCSFolderDisplayResponse listChildren(ISCSRequestModifier requestModifier,
                                       ISCSContext SCSContext,
                                       ISCSFolderID folderID)
                                       throws CommandException

List the contents of the given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_DISPLAY"

listFolders

ISCSFolderListFoldersResponse listFolders(ISCSContext SCSContext,
                                          ISCSFolderID folderID)
                                          throws CommandException

List the child folders of a given folder.

Parameters:

SCSContext - the context object representing the current user

folderID - the folder ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listFolders

ISCSFolderListFoldersResponse listFolders(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          ISCSFolderID folderID)
                                          throws CommandException

List the child folders of a given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the folder ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listFolders

ISCSFolderListFoldersResponse listFolders(ISCSContext SCSContext,
                                          ISCSFolderPathID folderPathID)
                                          throws CommandException

List the child folders of a given folder.

Parameters:

SCSContext - the context object representing the current user

folderPathID - the folder path ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listFolders

ISCSFolderListFoldersResponse listFolders(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          ISCSFolderPathID folderPathID)
                                          throws CommandException

List the child folders of a given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderPathID - the folder path ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listContents

ISCSFolderListContentsResponse listContents(ISCSContext SCSContext,
                                            ISCSFolderID folderID)
                                            throws CommandException

List the child folders of a given folder.

Parameters:

SCSContext - the context object representing the current user

folderID - the folder ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listContents

ISCSFolderListContentsResponse listContents(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSFolderID folderID)
                                            throws CommandException

List the child folders of a given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the folder ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listContents

ISCSFolderListContentsResponse listContents(ISCSContext SCSContext,
                                            ISCSFolderPathID folderPathID)
                                            throws CommandException

List the child folders of a given folder.

Parameters:

SCSContext - the context object representing the current user

folderPathID - the folder path ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

listContents

ISCSFolderListContentsResponse listContents(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSFolderPathID folderPathID)
                                            throws CommandException

List the child folders of a given folder.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderPathID - the folder path ID to query

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_GET_COLLECTIONS"

moveItems

ISCSFolderMultiNodeResponse moveItems(ISCSContext SCSContext,
                                      ISCSFolderID activeFolderID,
                                      java.util.Collection folderIDs,
                                      java.util.Collection itemIDs)
                                      throws CommandException

Move a folder from one folder to another.

Parameters:

SCSContext - the context object representing the current user

activeFolderID - the active folder ID of the destination folder

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_MOVE_LOT"

moveItems

ISCSFolderMultiNodeResponse moveItems(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSFolderID activeFolderID,
                                      java.util.Collection folderIDs,
                                      java.util.Collection itemIDs)
                                      throws CommandException

Move a folder from one folder to another.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

activeFolderID - the active folder ID of the destination folder

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_MOVE_LOT"

copyItems

ISCSFolderMultiNodeResponse copyItems(ISCSContext SCSContext,
                                      ISCSFolderID activeFolderID,
                                      java.util.Collection folderIDs,
                                      java.util.Collection itemIDs)
                                      throws CommandException

Move a folder from one folder to another.

Parameters:

SCSContext - the context object representing the current user

activeFolderID - the active folder ID of the destination folder

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_MOVE_LOT"

copyItems

ISCSFolderMultiNodeResponse copyItems(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSFolderID activeFolderID,
                                      java.util.Collection folderIDs,
                                      java.util.Collection itemIDs)
                                      throws CommandException

Move a folder from one folder to another.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

activeFolderID - the active folder ID of the destination folder

folderIDs - a collection of ISCSFolderID objects representing the folders to move

itemIDs - a collection of ISCSContentID objects representing the content items to move

Throws:

CommandException

See Also:

"Content Server Documentation for: "COLLECTION_MOVE_LOT"

propagateMetadata

ISCSServerResponse propagateMetadata(ISCSContext SCSContext,
                                     ISCSFolderID folderID)
                                     throws CommandException

Propagates (updates) folder metadata.

Parameters:

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_UPDATE_META"

propagateMetadata

ISCSServerResponse propagateMetadata(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     ISCSFolderID folderID)
                                     throws CommandException

Propagates (updates) folder metadata.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderID - the folder ID

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_UPDATE_META"

search

ISCSFolderSearchResponse search(ISCSContext SCSContext,
                                java.lang.String queryText,
                                java.lang.String sortOrder,
                                java.lang.String sortKey,
                                int resultCount)
                                throws CommandException

Searches the content server for folder nodes. <p/> This command differs from others in that it's property fields do not match the properties to be sent to the content server service. The number of properties that can be set for COLLECTION_SEARCH_RESULTS makes this approach unwieldly. As a result the field queryText can be used to set a number of different properties, it's format is a small subset of the verity search syntax and takes the following format: <p/> [leftOperand] [operator] '[rightOperand]' <AND> ... <p/> Where the left operand is the property to be searched on (ex. "dDocAuthor) and operator is the type of search to perform (ex. "<substring>, <contains>, <matches>, <starts>, <ends>"). The right operand is the text to search for. Some examples: <p/> "dCollectionName <contains> 'myfolder'" "dCollectionOwner <matches> 'me' <AND> dCollectionName <contains> 'myfolder'" <p/> Each search leaf can only be <AND>ed together as the service does not support any other type of branching operation.

Parameters:

SCSContext - the context object representing the current user

queryText - The search query string

sortOrder - The currently configured sort order, valid values are 'ASC' and 'DESC'.

sortKey -

resultCount - The number of search results to return.

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_SEARCH_RESULTS"

search

ISCSFolderSearchResponse search(ISCSRequestModifier requestModifier,
                                ISCSContext SCSContext,
                                java.lang.String queryText,
                                java.lang.String sortOrder,
                                java.lang.String sortKey,
                                int resultCount)
                                throws CommandException

Searches the content server for folder nodes. <p/> This command differs from others in that it's property fields do not match the properties to be sent to the content server service. The number of properties that can be set for COLLECTION_SEARCH_RESULTS makes this approach unwieldly. As a result the field queryText can be used to set a number of different properties, it's format is a small subset of the verity search syntax and takes the following format: <p/> [leftOperand] [operator] '[rightOperand]' <AND> ... <p/> Where the left operand is the property to be searched on (ex. "dDocAuthor) and operator is the type of search to perform (ex. "<substring>, <contains>, <matches>, <starts>, <ends>"). The right operand is the text to search for. Some examples: <p/> "dCollectionName <contains> 'myfolder'" "dCollectionOwner <matches> 'me' <AND> dCollectionName <contains> 'myfolder'" <p/> Each search leaf can only be <AND>ed together as the service does not support any other type of branching operation.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

queryText - The search query string

sortOrder - The currently configured sort order, valid values are 'ASC' and 'DESC'.

sortKey -

resultCount - The number of search results to return.

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_SEARCH_RESULTS"

updateInfo

ISCSFolderSingleNodeResponse updateInfo(ISCSContext SCSContext,
                                        ISCSFolder folderNode)
                                        throws CommandException

Update the metadata information on a given folder object.

Parameters:

SCSContext - the context object representing the current user

folderNode - the info containing the updated metadata information for this folder object

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_UPDATE"

updateInfo

ISCSFolderSingleNodeResponse updateInfo(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSFolder folderNode)
                                        throws CommandException

Update the metadata information on a given folder object.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

folderNode - the info containing the updated metadata information for this folder object

Throws:

CommandException

See Also:

"Content Server Documentation for: COLLECTION_UPDATE"

_createFolder

ISCSFolder _createFolder()

Create a new empty folder object.

Returns:

a new empty folder object

_createFolder

ISCSFolder _createFolder(java.lang.String folderID)

Create a new empty folder object with the given folder ID.

Parameters:

folderID - the folder ID

Returns:

a new empty folder object

_createFolderContent

ISCSFolderContent _createFolderContent()

Create a new empty active folder content object

Returns:

a new empty folder object

Skip navigation links