com.filenet.wcm.toolkit.server.dp
Class WcmAuthoringDataProvider

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.WcmDpModule
              extended bycom.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider
All Implemented Interfaces:
WcmDpModuleInterface, WcmModuleInterface

public class WcmAuthoringDataProvider
extends WcmDpModule

Authoring data provider handles XML data for adding, retreiving, and publishing documents, which are displayed by UI modules. It calls into the Content Java API.


Field Summary
static int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
          Defines the user or group search attribute type display name.
static int PRINCIPAL_SEARCH_ATTR_NONE
          Defines the user or group search attribute type none.
static int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
          Defines the user or group search attribute type short name.
static int PRINCIPAL_SEARCH_SORT_ASCENDING
          Defines the user or group sort type ascending.
static int PRINCIPAL_SEARCH_SORT_DESCENDING
          Defines the user or group sort type descending.
static int PRINCIPAL_SEARCH_SORT_NONE
          Defines the user or group sort type none.
static int PRINCIPAL_SEARCH_TYPE_CONTAINS
          Defines the user or group search type contains.
static int PRINCIPAL_SEARCH_TYPE_CUSTOM
          Defines the user or group search type custom.
static int PRINCIPAL_SEARCH_TYPE_EXACT
          Defines the user or group search type exact.
static int PRINCIPAL_SEARCH_TYPE_NONE
          Defines the user or group search type none.
static int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
          Defines the user or group search type prefix match.
static int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
          Defines the user or group search type suffix match.
static java.lang.String PROPERTY_STATE_MODIFIED
           
static java.lang.String PROPERTY_STATE_NOT_CHANGED
          Property state values 1 means the property has been modified 2 means the property has been modified but not yet validated - this value is currently used only on date properties.
static java.lang.String PROPERTY_STATE_NOT_VALIDATED
           
static int RESERVATION_TYPE_COLLABORATIVE
          Integer representing a collaborative checkout type.
static int RESERVATION_TYPE_DEFAULT
          Integer representing the default checkout type defined by the content engine server
static int RESERVATION_TYPE_EXCLUSIVE
          Integer representing an exclusive checkout type.
static int STATE_CLEAR_EXCEPTION
          Value of 4194304; clear document lifecycle exception state.
static int STATE_DEMOTE
          Value of 2097152; demote document lifecycle to previous state.
static int STATE_PROMOTE
          Value of 1048576; promote document lifecycle to next state.
static int STATE_RESET
          Value of 5242880; reset a new version of the document to the initial state.
static int STATE_SET_EXCEPTION
          Value of 3145728; set document lifecycle exception state (when a document is in an exception state, the document can neither be promoted nor demoted.)
static java.lang.String TYPE
          Authoring Data Provider type.
static int TYPE_CLASSDESCRIPTION
          Integer representing a ClassDescription object.
static int TYPE_CUSTOMOBJECT
          Integer representing a CustomObject object type.
static int TYPE_DOCUMENT
          Integer representing a Document object type.
static int TYPE_FOLDER
          Integer representing a Folder object.
static int TYPE_LINK
          Integer representing a Link type.
static int TYPE_OBJECT_STORE
          Integer representing a objectStore object.
static int TYPE_PUBLISH_TEMPLATE
          Integer representing a PublishTemplate object.
static int TYPE_SECURITY_POLICY
          Integer representing a SecurityPolicy object.
static int TYPE_STORED_SEARCH
          Integer representing a StoredSearch object.
static int TYPE_VERSIONSERIES
          Integer representing a VersionSeries object.
static int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
          Integer representing a Workflow Subscription type.
static int TYPE_WORKFLOWDEFINITION
          Integer representing a Workflow Definition type.
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule
cache
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmAuthoringDataProvider()
          WcmAuthoringDataProvider Constructor
WcmAuthoringDataProvider(java.lang.String name)
          WcmAuthoringDataProvider Constructor
 
Method Summary
 java.lang.String addCustomObject(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID)
          Create a Custom Object.
 java.lang.String addCustomObject(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, org.w3c.dom.Document properties, org.w3c.dom.Document permissions)
          Create a Custom Object.
 java.lang.String addDocument(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, org.w3c.dom.Document properties, org.w3c.dom.Document permissions, java.lang.String externalReference, java.lang.String mimeType, boolean minorVersion)
          Add a document to server.
 java.lang.String addDocument(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, org.w3c.dom.Document properties, org.w3c.dom.Document permissions, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType, boolean autoClassify, boolean minorVersion)
          Add a document to server.
 java.lang.String addDocument(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, java.lang.String externalReference, boolean minorVersion)
          Add an external document to server.
 java.lang.String addDocument(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, java.lang.String externalReference, java.lang.String mimeType, boolean minorVersion)
          Add an external document to server.
 java.lang.String addDocument(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType, boolean autoClassify, boolean minorVersion)
          Add a document to server.
 java.lang.String addFolder(java.lang.String objectStoreID, java.lang.String parentFolderID, java.lang.String folderName, java.lang.String classID)
          Create a folder.
 java.lang.String addSecurityPolicy(java.lang.String objectStoreID)
          Add Security Policy.
 java.lang.String addWorkflowSubscription()
          Add workflow subscriptions.
 boolean canCancelCheckout(java.lang.String objectStoreID, java.lang.String documentID)
          This method determines if the authenticated user can cancel checkout the checked out document.
 boolean canCheckIn(java.lang.String objectStoreID, java.lang.String documentID)
          This method determines if the authenticated user can checkin a checked out document.
 boolean canCheckInAsMajorVersion(java.lang.String objectStoreID, java.lang.String documentID)
          This method determines if the authenticated user can checkin a checked out document as a new released version.
 boolean changeObjectClass(java.lang.String objectStoreID, java.lang.String objectID, java.lang.String classID, int objectType)
          This method change object to new class with new properties.
 boolean checkLinkClass(java.lang.String objectStoreName, java.lang.String classId, java.lang.String[] linkClassIDs, boolean[] subClasses, boolean[] operation)
          Check the class to see if the given operation is allowed
protected static boolean checkParam(java.lang.Object o)
          Make sure object is not null and has some value.
 void clearCache(java.lang.String objectStoreName, java.lang.String objectId, int mode, int objectType, java.lang.String[] parentIds)
           
 java.lang.String createLink()
          Create a link object
 java.lang.String createLink(java.lang.String objectStoreID, java.lang.String classId, java.lang.String head, java.lang.String tail, boolean cascadeDelete, com.filenet.wcm.api.Properties properties)
          Integration mode: create a link between documents
 com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList, boolean replaceCreatorOwner)
          Create a JavaAPI's Permissions from XML node list Each node must have children nodes of GRANTEENAME, GRANTETYPE, ACCESSTYPE, ACCESS with or without STATE If State is specified and its value is WcmSecurityUtil.REMOVED then we don't send back those node to signal it has been removed from permission list.
 com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName, org.w3c.dom.NodeList propertiesNodeList)
          Create a JavaAPI's Properties from XML node list Each node must have children nodes of SYMNAME, STATE, and VALUE/VALUES We only pick node that has state marked as modify to avoid problem of sending back read only property.
 void deleteDocumentElement(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int element)
          remove document content.
 void deleteObject(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Delete an object.
 java.util.Map deleteVersion(java.lang.String objectStoreID, java.lang.String[] documentID)
          Delete the selected version from the version series object.
 boolean deleteWorkflowSubscription(java.lang.String objectStoreID, java.lang.String objectID)
          Delete a Workflow Subscription.
 void demoteVersion(java.lang.String objectStoreID, java.lang.String documentID)
          Demote to the previous major version
 boolean doCancelCheckout(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Cancel checkout of a document.
 java.lang.String doCheckinDocument(java.lang.String objectStoreID, java.lang.String objectID, org.w3c.dom.Document properties, org.w3c.dom.Document permissions, java.lang.String externalReference, java.lang.String classID, java.lang.String mimeType, boolean minorVersion)
          Save an external document back to server and create a new version of it.
 java.lang.String doCheckinDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, org.w3c.dom.Document properties, org.w3c.dom.Document permissions, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String classID, java.lang.String mimeType, boolean autoClassify, boolean minorVersion)
          Save document content back to server and create a new version of it.
 java.lang.String doCheckinDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String classID, java.lang.String mimeType, boolean autoClassify, boolean minorVersion)
          Save document content back to server and create a new version of it.
 java.lang.String doCheckinDocument(java.lang.String objectStoreID, java.lang.String objectID, java.lang.String externalReference, java.lang.String classID, java.lang.String mimeType, boolean minorVersion)
          Save an external document back to server and create a new version of it.
 java.lang.String doCheckoutDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Check out a document.
 java.lang.String doCheckoutDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int reservationType)
          Check out a document.
 java.util.Map doCheckoutDocument(java.lang.String objectStoreID, java.lang.String vsID, java.lang.String[] propIDs)
          Check out a document from the version series.
 boolean doCopyToAnotherFolder(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String objID, int objectType)
          Copy a document to another folder.
 boolean documentHasContent(java.lang.String objectStoreID, java.lang.String objectID)
          This method returns a Boolean value back indicating that there is content in the first content element of the document.
 com.filenet.wcm.api.TransportInputStream doDownloadDocument(java.lang.String objectStoreID, java.lang.String documentID)
          Retrieve document content without a checkout.
 void doMoveFolder(java.lang.String objectStoreID, java.lang.String objID, java.lang.String destinationFolderID)
          Moves an object from one folder to another in a transaction.
 void doMoveObject(java.lang.String objectStoreID, java.lang.String objID, int objectType, java.lang.String sourceFolderID, java.lang.String destinationFolderID)
          Moves an object from one folder to another in a transaction.
 boolean doRepublish(java.lang.String objectStoreID, java.lang.String sourceDocID, java.lang.String publishDocID, java.lang.String name)
          Republish previous publication document.
 boolean doUnfileObject(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String objID, int objectType)
          Remove a document from a folder.
 org.w3c.dom.Document findRealmGroups(java.lang.String realmId, java.lang.String searchPattern, int searchType, int searchedAttribute, int sortType, int maxResults, boolean refresh)
          Returns realm groups list xml based on the specified search criteria.
 org.w3c.dom.Document findRealmUsers(java.lang.String realmId, java.lang.String searchPattern, int searchType, int searchedAttribute, int sortType, int maxResults, boolean refresh)
          Return realm users list xml based on the specified search criteria.
 org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID, java.lang.String[] propIDs, boolean refresh)
          Return the current logged on user's list of checked out documents.
 org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID, java.lang.String[] propIDs, java.lang.String[] mimeTypes, boolean refresh)
          Return the current logged on user's list of checked out documents.
 org.w3c.dom.Document getClassPermissions(java.lang.String objectStoreID, java.lang.String classID, boolean refresh)
          Return specified class default permissions.
 org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, boolean refresh)
          Return the specified class's property description collection.
 java.lang.String getCurrentMajorVersionDocID(java.lang.String objectStoreID, java.lang.String vsID)
          Use version series id to retrieve current released major version document id.
 org.w3c.dom.Document getCurrentPublishingDocument(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh)
          Return the current published documents for the specified source document.
 java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID, java.lang.String vsID)
          Use version series id to retrieve current version document id.
 java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Return the current version ID
 int getDocumentContentCount(java.lang.String objectStoreID, java.lang.String objectID)
          This method returns the number of document contains contents.
 com.filenet.wcm.api.TransportInputStream getDocumentElement(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int element)
          Save document content back to server without checking in the document.
 java.lang.String getDocumentURL(java.lang.String objectStoreID, java.lang.String documentID)
          Return the Content Reference Location or URL of an external document.
 org.w3c.dom.Document getDocumentVersions(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propIDs, boolean refresh)
          Return the specified document versions list.
 org.w3c.dom.Document getDocumentVersions(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh)
          Return the specified document versions list.
 java.lang.String getFilename(java.lang.String objectStoreID, java.lang.String documentID)
          Return document's file name.
 org.w3c.dom.Document getFoldersFiledIn(java.lang.String objectStoreID, java.lang.String objectID, java.lang.String[] propIDs, int objectType, boolean removeRootFolder, boolean refresh)
          Return a folders list where document filed in.
 org.w3c.dom.Document getFoldersFiledIn(java.lang.String objectStoreID, java.lang.String objectID, java.lang.String[] propIDs, int objectType, boolean removeRootFolder, boolean addContainmentName, boolean refresh)
          Return a folders list where document filed in.
 org.w3c.dom.Document getHeadLinksXML(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propNames, boolean refresh)
          Get the Head Links XML on a Base Object
 java.lang.String[] getLifecycleStates(java.lang.String objectStoreID, java.lang.String documentID)
          Return life cycle states from object store.
 java.lang.String getLinkClassId(java.lang.String objectStoreName, java.lang.String objectId)
          Returns the Link Class Id
 java.util.List getMultiTransferElementList(java.lang.String objectStoreID, java.lang.String documentID)
          Return document's content in a list of TransportInputStream.
 java.lang.String getNamePropertyFromProperties(java.lang.String nameProperty)
          Return name property from properties collection.
 org.w3c.dom.Document getObjectPermissions(java.lang.String objectStoreID, java.lang.String objectID, int objectType, boolean refresh)
          Return specified object's permissions.
 org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int objectType, boolean refresh)
          Return specified object type's classes from object store.
 org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int objectType, java.util.Set excludedClasses, boolean refresh)
          Return specified object type's classes from object store excluding any classes specified by the excluded set.
 org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, java.lang.String[] classDescs, boolean refresh)
          Return specified class descriptions from object store.
 org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, java.lang.String[] classDescs, java.util.Set excludedClasses, boolean refresh)
          Return specified class descriptions from object store excluding any classes specified by the excluded set.
 java.lang.String getObjectStoreId(java.lang.String objectStoreName)
          Return specified object store id {GUID}
 org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID, int objectType, boolean refresh)
          Return the specified object store's object type property description collection.
 org.w3c.dom.Document getProperties(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propIDs, boolean refresh)
          Return specified object's class properties.
 org.w3c.dom.Document getPropertyChoiceList(java.lang.String objectStoreID, java.lang.String cvlValueID, int depth, boolean refresh)
          Return a property choice list by CVL value ID.
 java.lang.Object getPropertyDescriptionValue(java.lang.String objectStoreID, java.lang.String classID, java.lang.String symbolicName, java.lang.String propId)
          Returns the Property Description's Property Value
 java.util.Hashtable getPropertyValue(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propIDs)
          Return object's selected property.
 org.w3c.dom.Document getPublishingTemplate(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh)
          Return the current object store supported publishing templates.
 org.w3c.dom.Document getRealmGroups(java.lang.String realmId, boolean refresh)
          Deprecated. Use findRealmGroups()
 org.w3c.dom.Document getRealmsList(boolean refresh)
          Return realms list back.
 org.w3c.dom.Document getRealmUsers(java.lang.String realmId, boolean refresh)
          Deprecated. Use findRealmUsers()
 java.lang.String getReservationID(java.lang.String objectStoreID, java.lang.String documentID)
          Return reservation object ID from specified document ID.
 java.lang.String getRootFolderID(java.lang.String objectStore)
          This function returns the ID of the root folder
 org.w3c.dom.Document getSecurityPoliciesXML(java.lang.String objectStoreID, boolean refresh)
          Returns the requested security polices xml.
 java.lang.String getSecurityPolicyID(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Return the security policy object ID from specified object ID.
 boolean getSecurityRight(java.lang.String objectStoreID, java.lang.String objectID, int objectType, long accessMask, boolean refresh)
          This method returns a Boolean value back indicating current user has right by accessMask.
 boolean getSecurityRight(java.lang.String objectStoreID, java.lang.String objectID, int objectType, long accessMask, java.lang.String collectionType)
          This method returns a Boolean value back indicating current user has right by accessMask.
 org.w3c.dom.Document getSecurityTemplateXML(java.lang.String objectStoreID, java.lang.String securityPolicyID, boolean refresh)
          Returns the requested security template xml.
protected  com.filenet.wcm.api.Session getSession()
          Return logon session object from dataStore.
 org.w3c.dom.Document getSingleClassDescription(java.lang.String objectStoreID, java.lang.String classDescsId, int objectType)
          Returns class Description xml for a single class description.
 org.w3c.dom.Document getTailLinksXML(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propNames, boolean refresh)
          Get the Tail Links XML on a Base Object
 int getUserAccess(java.lang.String objectStoreID, java.lang.String objectID, int objectType, boolean refresh)
          This method returns the access rights (permissions) of the specified type for the current user on the selected object
 int getUserAccess(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String collectionType)
          This method returns the access rights (permissions) of the specified type for the current user on the selected object
 java.lang.String getVersionSeriesIDFromDocID(java.lang.String objectStoreID, java.lang.String docID)
          Return version series id from document id.
 java.lang.String[] getVersionStatusLookups(java.lang.String objectStoreID)
          Returns the version status labels.
 org.w3c.dom.Document getWorkflowSubscriptionsXML(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int isolatedRegion, boolean getAllSubscriptions, java.lang.String[] propIDs, boolean refresh)
          Get object's workflow subscriptions.
 org.w3c.dom.Document getWorkflowSubscriptionXML(java.lang.String objectStoreID, java.lang.String objectID, boolean refresh)
          Return workflow subscription in XML format.
protected  org.w3c.dom.Document getXMLDocument(java.lang.String xml, java.lang.String key)
          Pack XML string into a Document object and cache it into a window property to speed up future data retrival time.
protected  org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml, java.lang.String key)
          Pack XML string into a Document object and cache it into class property bag to speed up future data retrival time.
 boolean isCheckedOut(java.lang.String objectStoreID, java.lang.String documentID)
          Used to tell if a document is checked out.
 boolean isCheckedOutByCurrenUser(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Return true if the document is currently checked out by the login user.
 boolean isDocument(java.lang.String objectStoreID, java.lang.String ID)
          Used to tell if a class description is derived from the document class
 boolean isFiled(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Used to tell if the object is filed in a folder
 boolean isFolder(java.lang.String objectStoreID, java.lang.String ID)
          Used to tell if a class description is derived from a folder class
 boolean isInstantiableByUser(java.lang.String objectStoreID, java.lang.String classType)
          Tells you if this class is instantiable by the current user
 boolean isLink(java.lang.String objectStoreID, java.lang.String ID)
          Used to tell if a class description is derived from a link class
 boolean isSubclassOf(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String parentClass)
          Check to see if object's class is the same or a sub-class of prarent class.
 boolean isSubclassOf(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String classObjectStore, java.lang.String className)
          Returns true if the given object has a class ID that is the same as the given class's ID or one of its descendants The class ID is retrieved from the object store where it was defined, then compared on the object's object store.
 boolean isSubclassOf(java.lang.String objectStoreID, java.lang.String parentClass, java.lang.String testClass)
          Test if testClass is a subclass of parentClass
 boolean isWebFolder(java.lang.String objectStoreID, java.lang.String objectID)
          Deprecated. This method has been deprecated you should use new method from WebContentDataProvider.
 org.w3c.dom.Document mergeRealmGroups(boolean refresh)
          Deprecated. Use finRealmGroups() (4.0)
 org.w3c.dom.Document mergeRealmUsers(boolean refresh)
          Deprecated. Use findRealmUsers() (4.0).
 void promoteVersion(java.lang.String objectStoreID, java.lang.String documentID)
          Promote the document as a new majar version.
static java.lang.String readFromFile(java.lang.String sFileName)
          Deprecated. This function does not belong here
 void replaceDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int index, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType)
          Save document content back to server without checking in the document.
 void saveDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType)
          Save document content back to server without checking in the document.
 void saveDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType, int offset)
          Save document content back to server without checking in the document.
 void saveDocumentElement(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int element, com.filenet.wcm.api.TransportInputStream documentContents, java.lang.String mimeType)
          Save document content back to server without checking in the document.
 boolean setLifecycleState(java.lang.String objectStoreID, java.lang.String documentID, int state)
          Set a document's life cycle state.
 boolean setObjectPermissions(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Save specified object permissions.
 boolean setProperties(java.lang.String objectStoreID, java.lang.String objectID, int objectType)
          Save object properties.
 boolean setProperty(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String sID, java.lang.Object o)
          Save a single property for the specified object.
 boolean setPublishingTemplate(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String templateID, java.lang.String name)
          Publish document with user-selected Publishing Template
 java.lang.String setSecurityPolicyProperties(java.lang.String objectStoreID, java.lang.String policyId)
          Set the properties on a security Policy.
 void setSortParameters(java.lang.String folderNameProperty, java.lang.String documentNameProperty)
          This setup the property to be sorted by in certain XML get method.
 boolean setWorkflowSubscriptionProperties(java.lang.String objectID)
          Set Properties on a Workflow Subscription.
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule
type
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

TYPE_DOCUMENT

public static final int TYPE_DOCUMENT
Integer representing a Document object type. Value is 1.

See Also:
Constant Field Values

TYPE_FOLDER

public static final int TYPE_FOLDER
Integer representing a Folder object. Value is 2.

See Also:
Constant Field Values

TYPE_OBJECT_STORE

public static final int TYPE_OBJECT_STORE
Integer representing a objectStore object. Value is 4.

See Also:
Constant Field Values

TYPE_CLASSDESCRIPTION

public static final int TYPE_CLASSDESCRIPTION
Integer representing a ClassDescription object. Value is 25.

See Also:
Constant Field Values

TYPE_STORED_SEARCH

public static final int TYPE_STORED_SEARCH
Integer representing a StoredSearch object. Value is -100.

See Also:
Constant Field Values

TYPE_SECURITY_POLICY

public static final int TYPE_SECURITY_POLICY
Integer representing a SecurityPolicy object. Value is 1170.

See Also:
Constant Field Values

TYPE_PUBLISH_TEMPLATE

public static final int TYPE_PUBLISH_TEMPLATE
Integer representing a PublishTemplate object. Value is -101.

See Also:
Constant Field Values

TYPE_VERSIONSERIES

public static final int TYPE_VERSIONSERIES
Integer representing a VersionSeries object. Value is 1140.

See Also:
Constant Field Values

TYPE_CUSTOMOBJECT

public static final int TYPE_CUSTOMOBJECT
Integer representing a CustomObject object type. Value is 15.

See Also:
Constant Field Values

TYPE_WORKFLOW_CLASS_SUBSCRIPTION

public static final int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
Integer representing a Workflow Subscription type. Value is 1166.

See Also:
Constant Field Values

TYPE_WORKFLOWDEFINITION

public static final int TYPE_WORKFLOWDEFINITION
Integer representing a Workflow Definition type. Value is 1160.

See Also:
Constant Field Values

TYPE_LINK

public static final int TYPE_LINK
Integer representing a Link type. Value is 1156.

See Also:
Constant Field Values

STATE_PROMOTE

public static final int STATE_PROMOTE
Value of 1048576; promote document lifecycle to next state.

See Also:
Constant Field Values

STATE_DEMOTE

public static final int STATE_DEMOTE
Value of 2097152; demote document lifecycle to previous state.

See Also:
Constant Field Values

STATE_SET_EXCEPTION

public static final int STATE_SET_EXCEPTION
Value of 3145728; set document lifecycle exception state (when a document is in an exception state, the document can neither be promoted nor demoted.)

See Also:
Constant Field Values

STATE_CLEAR_EXCEPTION

public static final int STATE_CLEAR_EXCEPTION
Value of 4194304; clear document lifecycle exception state.

See Also:
Constant Field Values

STATE_RESET

public static final int STATE_RESET
Value of 5242880; reset a new version of the document to the initial state.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_NONE

public static final int PRINCIPAL_SEARCH_TYPE_NONE
Defines the user or group search type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_CUSTOM

public static final int PRINCIPAL_SEARCH_TYPE_CUSTOM
Defines the user or group search type custom.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH

public static final int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
Defines the user or group search type prefix match.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH

public static final int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
Defines the user or group search type suffix match.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_CONTAINS

public static final int PRINCIPAL_SEARCH_TYPE_CONTAINS
Defines the user or group search type contains.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_TYPE_EXACT

public static final int PRINCIPAL_SEARCH_TYPE_EXACT
Defines the user or group search type exact.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_NONE

public static final int PRINCIPAL_SEARCH_SORT_NONE
Defines the user or group sort type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_ASCENDING

public static final int PRINCIPAL_SEARCH_SORT_ASCENDING
Defines the user or group sort type ascending.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_SORT_DESCENDING

public static final int PRINCIPAL_SEARCH_SORT_DESCENDING
Defines the user or group sort type descending.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_NONE

public static final int PRINCIPAL_SEARCH_ATTR_NONE
Defines the user or group search attribute type none.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_SHORT_NAME

public static final int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
Defines the user or group search attribute type short name.

See Also:
Constant Field Values

PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME

public static final int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
Defines the user or group search attribute type display name.

See Also:
Constant Field Values

RESERVATION_TYPE_COLLABORATIVE

public static final int RESERVATION_TYPE_COLLABORATIVE
Integer representing a collaborative checkout type.

See Also:
Constant Field Values

RESERVATION_TYPE_DEFAULT

public static final int RESERVATION_TYPE_DEFAULT
Integer representing the default checkout type defined by the content engine server

See Also:
Constant Field Values

RESERVATION_TYPE_EXCLUSIVE

public static final int RESERVATION_TYPE_EXCLUSIVE
Integer representing an exclusive checkout type.

See Also:
Constant Field Values

PROPERTY_STATE_NOT_CHANGED

public static final java.lang.String PROPERTY_STATE_NOT_CHANGED
Property state values 1 means the property has been modified 2 means the property has been modified but not yet validated - this value is currently used only on date properties. Once validated, it is changed to a 1 or modified state.

See Also:
Constant Field Values

PROPERTY_STATE_MODIFIED

public static final java.lang.String PROPERTY_STATE_MODIFIED
See Also:
Constant Field Values

PROPERTY_STATE_NOT_VALIDATED

public static final java.lang.String PROPERTY_STATE_NOT_VALIDATED
See Also:
Constant Field Values

TYPE

public static final java.lang.String TYPE
Authoring Data Provider type.

See Also:
Constant Field Values
Constructor Detail

WcmAuthoringDataProvider

public WcmAuthoringDataProvider()
                         throws java.lang.Exception
WcmAuthoringDataProvider Constructor

Throws:
java.lang.Exception

WcmAuthoringDataProvider

public WcmAuthoringDataProvider(java.lang.String name)
                         throws java.lang.Exception
WcmAuthoringDataProvider Constructor

Parameters:
name - Module name
Throws:
java.lang.Exception
Method Detail

clearCache

public void clearCache(java.lang.String objectStoreName,
                       java.lang.String objectId,
                       int mode,
                       int objectType,
                       java.lang.String[] parentIds)
                throws java.lang.Exception
Throws:
java.lang.Exception

getDocumentURL

public java.lang.String getDocumentURL(java.lang.String objectStoreID,
                                       java.lang.String documentID)
                                throws java.lang.Exception
Return the Content Reference Location or URL of an external document.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Returns:
String Return the Content Reference Location or URL of an external document.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getDocumentVersions

public org.w3c.dom.Document getDocumentVersions(java.lang.String objectStoreID,
                                                java.lang.String documentID,
                                                java.lang.String[] propIDs,
                                                boolean refresh)
                                         throws java.lang.Exception
Return the specified document versions list. Cached data will be stored in module property bag identified by DOC_VERS + objectStoreID + documentID.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
propIDs - A collection of property names. If specified, XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getDocumentVersions

public org.w3c.dom.Document getDocumentVersions(java.lang.String objectStoreID,
                                                java.lang.String objectID,
                                                int objectType,
                                                java.lang.String[] propIDs,
                                                boolean refresh)
                                         throws java.lang.Exception
Return the specified document versions list. Cached data will be stored in module property bag identified by DOC_VERS + objectStoreID + vsID.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object ID's object type.
propIDs - A collection of property names. If specified, XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getObjectStoreId

public java.lang.String getObjectStoreId(java.lang.String objectStoreName)
                                  throws java.lang.Exception
Return specified object store id {GUID}

Parameters:
objectStoreName - String holding the object store name
Returns:
String id {GUID} of the object store
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getObjectStoreClasses

public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID,
                                                  int objectType,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return specified object type's classes from object store. Cached data will be stored in module property bag identified by DOC_CLASSES + objectStoreID + objectType.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectType - Type of class descriptions to return, for example, document, folder or stored search.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getObjectStoreClasses

public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID,
                                                  int objectType,
                                                  java.util.Set excludedClasses,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return specified object type's classes from object store excluding any classes specified by the excluded set. Cached data will be stored in module property bag identified by DOC_CLASSES + objectStoreID + objectType.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectType - Type of class descriptions to return, for example, document, folder or stored search.
excludedClasses - Set holding class symnames.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getSingleClassDescription

public org.w3c.dom.Document getSingleClassDescription(java.lang.String objectStoreID,
                                                      java.lang.String classDescsId,
                                                      int objectType)
                                               throws java.lang.Exception
Returns class Description xml for a single class description. If the class description xml for the whole object type is avaialbe, it will return that.

Parameters:
objectStoreID -
classDescsId -
objectType -
Returns:
Document object
Throws:
java.lang.Exception

getObjectStoreClasses

public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID,
                                                  java.lang.String[] classDescs,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return specified class descriptions from object store. Cached data will be stored in module property bag identified by DOC_CLASSES + objectStoreID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classDescs - Array of class descriptions to return.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getObjectStoreClasses

public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID,
                                                  java.lang.String[] classDescs,
                                                  java.util.Set excludedClasses,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return specified class descriptions from object store excluding any classes specified by the excluded set. Cached data will be stored in module property bag identified by DOC_CLASSES + objectStoreID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classDescs - Array of class descriptions to return.
excludedClasses - Set holding class symnames.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getClassProperties

public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID,
                                               java.lang.String classID,
                                               boolean refresh)
                                        throws java.lang.Exception
Return the specified class's property description collection. If the properties have choices, the property descriptions will contain the first level of choice values. Cached data will be stored in module property bag identified by CLASS_PROPS + objectStoreID + classID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classID - GUID format of Class ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getObjectStorePropertyDescriptions

public org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID,
                                                               int objectType,
                                                               boolean refresh)
                                                        throws java.lang.Exception
Return the specified object store's object type property description collection. If the properties have choices, the property descriptions will contain the first level of choice values. Cached data will be stored in module property bag identified by CLASS_PROPS + objectStoreID + objectType.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectType - Type of class descriptions to return, for example, document, folder or stored search.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

readFromFile

public static java.lang.String readFromFile(java.lang.String sFileName)
Deprecated. This function does not belong here

Parameters:
sFileName -
Returns:
file contents

getProperties

public org.w3c.dom.Document getProperties(java.lang.String objectStoreID,
                                          java.lang.String objectID,
                                          int objectType,
                                          java.lang.String[] propIDs,
                                          boolean refresh)
                                   throws java.lang.Exception
Return specified object's class properties. Cached data will be stored in module property bag identified by OBJ_PROPS + objectStoreID + objectID.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
propIDs - A collection of property names. If specified, XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setWorkflowSubscriptionProperties

public boolean setWorkflowSubscriptionProperties(java.lang.String objectID)
                                          throws java.lang.Exception
Set Properties on a Workflow Subscription.

Parameters:
objectID - GUID of the workflow subscription.
Returns:
boolean indicate operation successful or not.
Throws:
java.lang.Exception - If there any errors occur.

setProperties

public boolean setProperties(java.lang.String objectStoreID,
                             java.lang.String objectID,
                             int objectType)
                      throws java.lang.Exception
Save object properties. This method expects a DOM object identified by WcmAuthoringStateKeys.PROPERTIES_KEY in memory. SetProperties uses helper method to collect properties node from document and translate it to JavaAPI's properties collection before setting it to an object.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's Object type.
Returns:
boolean indicate operation successful or not.
Throws:
java.lang.Exception - If there were problems retrieving data or with an invalid parameter.

getClassPermissions

public org.w3c.dom.Document getClassPermissions(java.lang.String objectStoreID,
                                                java.lang.String classID,
                                                boolean refresh)
                                         throws java.lang.Exception
Return specified class default permissions. Cached data will be stored in module property bag identified by OBJ_PERMS + objectStoreID + classID.

Parameters:
objectStoreID - GUID format of Object Store ID.
classID - GUID format of Class ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getObjectPermissions

public org.w3c.dom.Document getObjectPermissions(java.lang.String objectStoreID,
                                                 java.lang.String objectID,
                                                 int objectType,
                                                 boolean refresh)
                                          throws java.lang.Exception
Return specified object's permissions. If object type is object store, then data for root folder retrieved. Cached data will be stored in module property bag identified by OBJ_PERMS + objectStoreID + objectID.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setObjectPermissions

public boolean setObjectPermissions(java.lang.String objectStoreID,
                                    java.lang.String objectID,
                                    int objectType)
                             throws java.lang.Exception
Save specified object permissions. This set operation anticipates the Securities DOM object in module property bag identified by OBJ_PERMS + objectStoreID + objectID. The get operation stores a copy of data in module property and Workplace Property Page module modifies the same one.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
Returns:
boolean Operation successful or not.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getRealmsList

public org.w3c.dom.Document getRealmsList(boolean refresh)
                                   throws java.lang.Exception
Return realms list back. Cached data will be stored in module property bag identified by REALMS_LIST.

Parameters:
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getRealmGroups

public org.w3c.dom.Document getRealmGroups(java.lang.String realmId,
                                           boolean refresh)
                                    throws java.lang.Exception
Deprecated. Use findRealmGroups()

Return realm groups list. Cached data will be stored in module property bag identified by REALM_GROUPS.

Parameters:
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
realmId - When realmId is null or empty this method return default realms list with populated default realm's group list. Otherwise, it return requested realm's group list with previous requested data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getRealmUsers

public org.w3c.dom.Document getRealmUsers(java.lang.String realmId,
                                          boolean refresh)
                                   throws java.lang.Exception
Deprecated. Use findRealmUsers()

Return realm users list. Cached data will be stored in module property bag identified by REALM_USERS.

Parameters:
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
realmId - When realmId is null or empty this method return default realms list with populated default realm's group list. Otherwise, it return requested realm's group list with previous requested data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

findRealmUsers

public org.w3c.dom.Document findRealmUsers(java.lang.String realmId,
                                           java.lang.String searchPattern,
                                           int searchType,
                                           int searchedAttribute,
                                           int sortType,
                                           int maxResults,
                                           boolean refresh)
                                    throws java.lang.Exception
Return realm users list xml based on the specified search criteria.

Parameters:
realmId - The realm id.
searchPattern - String The search pattern to search for.
searchType - int The criteria to search by (Starts with, Contains or Ends with).
searchedAttribute - int The attribute to use in the search.
sortType - int The sort type.
maxResults - int The maximum number of users objects to return in the result collection
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

findRealmGroups

public org.w3c.dom.Document findRealmGroups(java.lang.String realmId,
                                            java.lang.String searchPattern,
                                            int searchType,
                                            int searchedAttribute,
                                            int sortType,
                                            int maxResults,
                                            boolean refresh)
                                     throws java.lang.Exception
Returns realm groups list xml based on the specified search criteria.

Parameters:
realmId - The realm id.
searchPattern - String The search pattern to search for.
searchType - int The criteria to search by (Starts with, Contains or Ends with).
searchedAttribute - int The attribute to use in the search.
sortType - int The sort type.
maxResults - int The maximum number of groups objects to return in the result collection
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

mergeRealmUsers

public org.w3c.dom.Document mergeRealmUsers(boolean refresh)
                                     throws java.lang.Exception
Deprecated. Use findRealmUsers() (4.0).

Return sorted realm users list. Cached data will be stored in module property bag identified by REALM_USERS.

Parameters:
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

mergeRealmGroups

public org.w3c.dom.Document mergeRealmGroups(boolean refresh)
                                      throws java.lang.Exception
Deprecated. Use finRealmGroups() (4.0)

Return sorted realms groups list. Cached data will be stored in module property bag identified by REALM_GROUPS.

Parameters:
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getActiveUserCheckedOutList

public org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID,
                                                        java.lang.String[] propIDs,
                                                        boolean refresh)
                                                 throws java.lang.Exception
Return the current logged on user's list of checked out documents. Cached data will be stored in module property bag identified by CHECKEDOUT_LIST + objectStoreID.

Parameters:
objectStoreID - GUID format of Object Store ID.
propIDs - A collection of property names. If specified XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getActiveUserCheckedOutList

public org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID,
                                                        java.lang.String[] propIDs,
                                                        java.lang.String[] mimeTypes,
                                                        boolean refresh)
                                                 throws java.lang.Exception
Return the current logged on user's list of checked out documents. Cached data will be stored in module property bag identified by CHECKEDOUT_LIST + objectStoreID.

Parameters:
objectStoreID - GUID format of Object Store ID.
propIDs - A collection of property names. If specified XML will only return those values; null will return all.
mimeTypes - Only documents of these mime types will be returned in the XML
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckinDocument

public java.lang.String doCheckinDocument(java.lang.String objectStoreID,
                                          java.lang.String objectID,
                                          int objectType,
                                          com.filenet.wcm.api.TransportInputStream documentContents,
                                          java.lang.String classID,
                                          java.lang.String mimeType,
                                          boolean autoClassify,
                                          boolean minorVersion)
                                   throws java.lang.Exception
Save document content back to server and create a new version of it. This check in operation requires that properties and securities document reside in class and module properties. Please see setObjectPermissions and setProperties for details. User can change document class during check-in, if classID is null or empty, AuthoringDataProvider will use previous doc class to setup properties and permissions, otherwise it will switch to use new doc and save its properties.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
documentContents - A TransportInputStream object that represents document content.
classID - GUID format of Class ID.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
autoClassify - If true, invokes autoclassification service from the Content Engine. If false, no autoclassification is requested. This parameter is ignored if doCheckin is false. For a stored search or publish template, a setting of true is ignored and is automatically set to false.
minorVersion - Is this the minor version.
Returns:
String GUID format of document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckinDocument

public java.lang.String doCheckinDocument(java.lang.String objectStoreID,
                                          java.lang.String objectID,
                                          int objectType,
                                          org.w3c.dom.Document properties,
                                          org.w3c.dom.Document permissions,
                                          com.filenet.wcm.api.TransportInputStream documentContents,
                                          java.lang.String classID,
                                          java.lang.String mimeType,
                                          boolean autoClassify,
                                          boolean minorVersion)
                                   throws java.lang.Exception
Save document content back to server and create a new version of it. User can change document class during check-in, if classID is null or empty, AuthoringDataProvider will use previous doc class to setup properties and permissions, otherwise it will switch to use new doc and save its properties.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
properties - org.w3c.dom.Document holding property values
permissions - org.w3c.dom.Document holding security settings
documentContents - A TransportInputStream object that represents document content.
classID - GUID format of Class ID.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
autoClassify - If true, invokes autoclassification service from the Content Engine. If false, no autoclassification is requested. This parameter is ignored if doCheckin is false. For a stored search or publish template, a setting of true is ignored and is automatically set to false.
minorVersion - Is this the minor version.
Returns:
String GUID format of document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckinDocument

public java.lang.String doCheckinDocument(java.lang.String objectStoreID,
                                          java.lang.String objectID,
                                          org.w3c.dom.Document properties,
                                          org.w3c.dom.Document permissions,
                                          java.lang.String externalReference,
                                          java.lang.String classID,
                                          java.lang.String mimeType,
                                          boolean minorVersion)
                                   throws java.lang.Exception
Save an external document back to server and create a new version of it.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
properties - org.w3c.dom.Document holding property values
permissions - org.w3c.dom.Document holding security settings
externalReference - A URL format of external reference.
classID - GUID format of Class ID.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
minorVersion - Is this the minor version.
Returns:
String GUID format of document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckinDocument

public java.lang.String doCheckinDocument(java.lang.String objectStoreID,
                                          java.lang.String objectID,
                                          java.lang.String externalReference,
                                          java.lang.String classID,
                                          java.lang.String mimeType,
                                          boolean minorVersion)
                                   throws java.lang.Exception
Save an external document back to server and create a new version of it. This check in operation requires that properties and securities document reside in class and module properties. Please see setObjectPermissions and setProperties for details. User can change document class during check-in, if classID is null or empty, AuthoringDataProvider will use previous doc class to setup properties and permissions, otherwise it will switch to use new doc and save its properties.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
externalReference - A URL format of external reference.
classID - GUID format of Class ID.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
minorVersion - Is this the minor version.
Returns:
boolean GUID format of document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

saveDocument

public void saveDocument(java.lang.String objectStoreID,
                         java.lang.String objectID,
                         int objectType,
                         com.filenet.wcm.api.TransportInputStream documentContents,
                         java.lang.String mimeType)
                  throws java.lang.Exception
Save document content back to server without checking in the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

saveDocument

public void saveDocument(java.lang.String objectStoreID,
                         java.lang.String objectID,
                         int objectType,
                         com.filenet.wcm.api.TransportInputStream documentContents,
                         java.lang.String mimeType,
                         int offset)
                  throws java.lang.Exception
Save document content back to server without checking in the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
offset - This is document index number (position) in reservation start with 1 not zero.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

replaceDocument

public void replaceDocument(java.lang.String objectStoreID,
                            java.lang.String objectID,
                            int objectType,
                            int index,
                            com.filenet.wcm.api.TransportInputStream documentContents,
                            java.lang.String mimeType)
                     throws java.lang.Exception
Save document content back to server without checking in the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
index - multi transfer content index number.
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

saveDocumentElement

public void saveDocumentElement(java.lang.String objectStoreID,
                                java.lang.String objectID,
                                int objectType,
                                int element,
                                com.filenet.wcm.api.TransportInputStream documentContents,
                                java.lang.String mimeType)
                         throws java.lang.Exception
Save document content back to server without checking in the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
element - Which element to put the content into.
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getDocumentElement

public com.filenet.wcm.api.TransportInputStream getDocumentElement(java.lang.String objectStoreID,
                                                                   java.lang.String objectID,
                                                                   int objectType,
                                                                   int element)
                                                            throws java.lang.Exception
Save document content back to server without checking in the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object type.
element - Which element to put the content into.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

deleteDocumentElement

public void deleteDocumentElement(java.lang.String objectStoreID,
                                  java.lang.String objectID,
                                  int objectType,
                                  int element)
                           throws java.lang.Exception
remove document content.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of document object id.
objectType - Object type.
element - Which element to remove, if element is -1 then remove all.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addDocument

public java.lang.String addDocument(java.lang.String objectStoreID,
                                    java.lang.String folderID,
                                    java.lang.String classID,
                                    com.filenet.wcm.api.TransportInputStream documentContents,
                                    java.lang.String mimeType,
                                    boolean autoClassify,
                                    boolean minorVersion)
                             throws java.lang.Exception
Add a document to server. This operation requires that properties and securities document reside in class and module propertis. Please see setObjectPermissions and setProperties for details.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document to file in.
classID - GUID format of Class ID.
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
autoClassify - If true, invokes autoclassification service from the Content Engine. If false, no autoclassification is requested. This parameter is ignored if doCheckin is false. For a stored search or publish template, a setting of true is ignored and is automatically set to false.
minorVersion - Is this the minor version.
Returns:
String GUID format of Document ID. Null if add operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addDocument

public java.lang.String addDocument(java.lang.String objectStoreID,
                                    java.lang.String folderID,
                                    java.lang.String classID,
                                    org.w3c.dom.Document properties,
                                    org.w3c.dom.Document permissions,
                                    com.filenet.wcm.api.TransportInputStream documentContents,
                                    java.lang.String mimeType,
                                    boolean autoClassify,
                                    boolean minorVersion)
                             throws java.lang.Exception
Add a document to server.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document to file in.
classID - GUID format of Class ID.
properties - org.w3c.dom.Document holding property values
permissions - org.w3c.dom.Document holding security settings
documentContents - A TransportInputStream object that represents document content.
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
autoClassify - If true, invokes autoclassification service from the Content Engine. If false, no autoclassification is requested. This parameter is ignored if doCheckin is false. For a stored search or publish template, a setting of true is ignored and is automatically set to false.
minorVersion - Is this the minor version.
Returns:
String GUID format of Document ID. Null if add operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addDocument

public java.lang.String addDocument(java.lang.String objectStoreID,
                                    java.lang.String folderID,
                                    java.lang.String classID,
                                    java.lang.String externalReference,
                                    boolean minorVersion)
                             throws java.lang.Exception
Add an external document to server. This operation requires that properties and securities document reside in class and module properties. Please see setObjectPermissions and setProperties for details. User can change document class during check-in, if classID is null or empty, AuthoringDataProvider will use previous doc class to setup properties and permissions, otherwise it will switch to use new doc and save its properties.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document to file in.
classID - GUID format of Class ID.
externalReference - A URL format of external reference
minorVersion - Is this the minor version.
Returns:
String GUID format of Document ID. Null if add operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addDocument

public java.lang.String addDocument(java.lang.String objectStoreID,
                                    java.lang.String folderID,
                                    java.lang.String classID,
                                    org.w3c.dom.Document properties,
                                    org.w3c.dom.Document permissions,
                                    java.lang.String externalReference,
                                    java.lang.String mimeType,
                                    boolean minorVersion)
                             throws java.lang.Exception
Add a document to server.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document to file in.
classID - GUID format of Class ID.
properties - org.w3c.dom.Document holding property values
permissions - org.w3c.dom.Document holding security settings
mimeType - documentContent's MIME type. If not null this will be MIME type of documentContents.
minorVersion - Is this the minor version.
Returns:
String GUID format of Document ID. Null if add operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addDocument

public java.lang.String addDocument(java.lang.String objectStoreID,
                                    java.lang.String folderID,
                                    java.lang.String classID,
                                    java.lang.String externalReference,
                                    java.lang.String mimeType,
                                    boolean minorVersion)
                             throws java.lang.Exception
Add an external document to server. This operation requires that properties and securities document reside in class and module properties. Please see setObjectPermissions and setProperties for details. User can change document class during check-in, if classID is null or empty, AuthoringDataProvider will use previous doc class to setup properties and permissions, otherwise it will switch to use new doc and save its properties.

Parameters:
objectStoreID - Object Store ID.
folderID - Folder ID where document to file in.
classID - Class ID.
externalReference - A URL format of external reference
mimeType - Mime Type of the external reference
minorVersion - Is this the minor version.
Returns:
String GUID format of Document ID. Null if add operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doDownloadDocument

public com.filenet.wcm.api.TransportInputStream doDownloadDocument(java.lang.String objectStoreID,
                                                                   java.lang.String documentID)
                                                            throws java.lang.Exception
Retrieve document content without a checkout. This operation does not create a reservation object on the server.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Returns:
documentContents Returned object represents document contents. If operation fails, then method returns a null object that signals error condition.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

demoteVersion

public void demoteVersion(java.lang.String objectStoreID,
                          java.lang.String documentID)
                   throws java.lang.Exception
Demote to the previous major version

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

promoteVersion

public void promoteVersion(java.lang.String objectStoreID,
                           java.lang.String documentID)
                    throws java.lang.Exception
Promote the document as a new majar version.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckoutDocument

public java.lang.String doCheckoutDocument(java.lang.String objectStoreID,
                                           java.lang.String objectID,
                                           int objectType)
                                    throws java.lang.Exception
Check out a document. Properties and ACLs can be retrieved by using the getObjectPermissions and getProperties methods. This operation creates a reservation object on the server for later checkin operation. Use doDownloadDocument to retrieve document content.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
Returns:
String GUID format of new checkout document.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckoutDocument

public java.lang.String doCheckoutDocument(java.lang.String objectStoreID,
                                           java.lang.String objectID,
                                           int objectType,
                                           int reservationType)
                                    throws java.lang.Exception
Check out a document. Properties and ACLs can be retrieved by using the getObjectPermissions and getProperties methods. This operation creates a reservation object on the server for later checkin operation. Use doDownloadDocument to retrieve document content.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
reservationType - int the reservation type.
Returns:
String GUID format of new checkout document.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCheckoutDocument

public java.util.Map doCheckoutDocument(java.lang.String objectStoreID,
                                        java.lang.String vsID,
                                        java.lang.String[] propIDs)
                                 throws java.lang.Exception
Check out a document from the version series. Properties and ACLs can be retrieved by using the getObjectPermissions and getProperties methods. This operation creates a reservation object on the server for later checkin operation. Use doDownloadDocument to retrieve document content.

Parameters:
objectStoreID - GUID format of Object Store ID.
vsID - GUID format of Version series ID.
propIDs - A collection of property name.
Returns:
Hashtable Return requested properties in name and value-pair format of the lastest version. Null means operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCopyToAnotherFolder

public boolean doCopyToAnotherFolder(java.lang.String objectStoreID,
                                     java.lang.String folderID,
                                     java.lang.String objID,
                                     int objectType)
                              throws java.lang.Exception
Copy a document to another folder. Destination folder can't be null.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document will be copied.
objID - GUID format of Document ID.
objectType - Object Id's object type.
Returns:
boolean Operation successful or not.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doUnfileObject

public boolean doUnfileObject(java.lang.String objectStoreID,
                              java.lang.String folderID,
                              java.lang.String objID,
                              int objectType)
                       throws java.lang.Exception
Remove a document from a folder. This operation does not delete document from object store.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of Folder ID where document filed in.
objID - GUID format of Document ID.
objectType - Object Id's object type.
Returns:
boolean Operation successful or not.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doMoveObject

public void doMoveObject(java.lang.String objectStoreID,
                         java.lang.String objID,
                         int objectType,
                         java.lang.String sourceFolderID,
                         java.lang.String destinationFolderID)
                  throws java.lang.Exception
Moves an object from one folder to another in a transaction. This operation does not delete document from object store.

Parameters:
objectStoreID - Object Store ID.
objID - GUID format of Document ID.
objectType - Object Id's object type.
sourceFolderID - Folder ID where document filed in.
destinationFolderID - Destination Folder ID
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doMoveFolder

public void doMoveFolder(java.lang.String objectStoreID,
                         java.lang.String objID,
                         java.lang.String destinationFolderID)
                  throws java.lang.Exception
Moves an object from one folder to another in a transaction. This operation does not delete document from object store.

Parameters:
objectStoreID - Object Store ID.
objID - GUID format of Document ID.
destinationFolderID - Destination Folder ID
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getCurrentPublishingDocument

public org.w3c.dom.Document getCurrentPublishingDocument(java.lang.String objectStoreID,
                                                         java.lang.String documentID,
                                                         java.lang.String[] propIDs,
                                                         boolean refresh)
                                                  throws java.lang.Exception
Return the current published documents for the specified source document. Cached data will be stored in module property bag identified by DOC_PUBLISHED + objectStoreID + documentID.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
propIDs - A collection of property names. If specified, XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPublishingTemplate

public org.w3c.dom.Document getPublishingTemplate(java.lang.String objectStoreID,
                                                  java.lang.String documentID,
                                                  java.lang.String[] propIDs,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return the current object store supported publishing templates. Cached data will be stored in module property bag identified by PUBLISH_TEMPLATE + objectStoreID + documentID.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
propIDs - A collection of property names. If specified XML will only return those values; null will return all.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setPublishingTemplate

public boolean setPublishingTemplate(java.lang.String objectStoreID,
                                     java.lang.String documentID,
                                     java.lang.String templateID,
                                     java.lang.String name)
                              throws java.lang.Exception
Publish document with user-selected Publishing Template

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
templateID - GUID format of Publishing Template ID.
name - New publication document name in XML format.
Returns:
boolean Operation successful or no.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doRepublish

public boolean doRepublish(java.lang.String objectStoreID,
                           java.lang.String sourceDocID,
                           java.lang.String publishDocID,
                           java.lang.String name)
                    throws java.lang.Exception
Republish previous publication document.

Parameters:
objectStoreID - GUID format of Object Store ID.
sourceDocID - GUID format of Source Document ID.
publishDocID - GUID format of Publication Document ID.
name - New publication document name in XML format.
Returns:
boolean Operation successful or no.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPropertyChoiceList

public org.w3c.dom.Document getPropertyChoiceList(java.lang.String objectStoreID,
                                                  java.lang.String cvlValueID,
                                                  int depth,
                                                  boolean refresh)
                                           throws java.lang.Exception
Return a property choice list by CVL value ID. Cached data will be stored in module property bag identified by PROP_CHOICE_LIST + objectStoreID + propertyID.

Parameters:
objectStoreID - GUID format of Object Store ID.
cvlValueID - GUID format of CVL value ID.
depth - depth of CVL values. -1 value gets all.
refresh - When set to true, data provider will attempt to get data from server disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addFolder

public java.lang.String addFolder(java.lang.String objectStoreID,
                                  java.lang.String parentFolderID,
                                  java.lang.String folderName,
                                  java.lang.String classID)
                           throws java.lang.Exception
Create a folder. This operation requires that properties and securities document reside in class and module property. Please see setObjectPermissions and setProperties for details.

Parameters:
objectStoreID - GUID format of Object Store ID.
parentFolderID - GUID format of parent folder ID where new folder will reside. To create a top folder, do not set, or set to null.
folderName - Folder name.
classID - GUID format of Folder's class ID.
Returns:
String GUID format of new created Folder ID. Return null if operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addCustomObject

public java.lang.String addCustomObject(java.lang.String objectStoreID,
                                        java.lang.String folderID,
                                        java.lang.String classID)
                                 throws java.lang.Exception
Create a Custom Object. This operation requires that properties and securities document reside in class and module property. Please see setObjectPermissions and setProperties for details.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of parent folder ID.
classID - GUID format of Custom Object's class ID.
Returns:
String GUID format of new created Custom Object ID. Return null if operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addCustomObject

public java.lang.String addCustomObject(java.lang.String objectStoreID,
                                        java.lang.String folderID,
                                        java.lang.String classID,
                                        org.w3c.dom.Document properties,
                                        org.w3c.dom.Document permissions)
                                 throws java.lang.Exception
Create a Custom Object.

Parameters:
objectStoreID - GUID format of Object Store ID.
folderID - GUID format of parent folder ID.
classID - GUID format of Custom Object's class ID.
properties - org.w3c.dom.Document holding property values
permissions - org.w3c.dom.Document holding security settings
Returns:
String GUID format of new created Custom Object ID. Return null if operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

doCancelCheckout

public boolean doCancelCheckout(java.lang.String objectStoreID,
                                java.lang.String objectID,
                                int objectType)
                         throws java.lang.Exception
Cancel checkout of a document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
Returns:
boolean Operation successful or not.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getFoldersFiledIn

public org.w3c.dom.Document getFoldersFiledIn(java.lang.String objectStoreID,
                                              java.lang.String objectID,
                                              java.lang.String[] propIDs,
                                              int objectType,
                                              boolean removeRootFolder,
                                              boolean refresh)
                                       throws java.lang.Exception
Return a folders list where document filed in. Cached data will be stored in module property bag identified by FOLDERS_FILEIN + objectStoreID + documentID.

Parameters:
objectStoreID - Object Store ID.
objectID - Object ID.
propIDs - A collection of property names. If specified XML will only return those values; null will return all.
objectType - Object type
removeRootFolder - Root folder will be removed from the XML if this parameter is true.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getFoldersFiledIn

public org.w3c.dom.Document getFoldersFiledIn(java.lang.String objectStoreID,
                                              java.lang.String objectID,
                                              java.lang.String[] propIDs,
                                              int objectType,
                                              boolean removeRootFolder,
                                              boolean addContainmentName,
                                              boolean refresh)
                                       throws java.lang.Exception
Return a folders list where document filed in. Cached data will be stored in module property bag identified by FOLDERS_FILEIN + objectStoreID + documentID.

Parameters:
objectStoreID - Object Store ID.
objectID - Object ID.
propIDs - A collection of property names. If specified XML will only return those values; null will return all.
objectType - Object type
removeRootFolder - Root folder will be removed from the XML if this parameter is true.
addContainmentName - The Containment Name from the dynamic referential containment ralationship object will be added to the folder properties collection if this parameter is true.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getRootFolderID

public java.lang.String getRootFolderID(java.lang.String objectStore)
                                 throws java.lang.Exception
This function returns the ID of the root folder

Parameters:
objectStore -
Returns:
root folder id
Throws:
java.lang.Exception

deleteWorkflowSubscription

public boolean deleteWorkflowSubscription(java.lang.String objectStoreID,
                                          java.lang.String objectID)
                                   throws java.lang.Exception
Delete a Workflow Subscription.

Parameters:
objectStoreID - GUID or Name of the Object Store.
objectID - GUID of the workflow subscription.
Returns:
boolean true if action was carried out.
Throws:
java.lang.Exception - If there any errors occur.

deleteObject

public void deleteObject(java.lang.String objectStoreID,
                         java.lang.String objectID,
                         int objectType)
                  throws java.lang.Exception
Delete an object. Thows

Parameters:
objectStoreID - GUID or Name of the Object Store.
objectID - GUID format of an object id.
objectType - Object Id's object type.
Throws:
java.lang.Exception - If there any errors occur.

deleteVersion

public java.util.Map deleteVersion(java.lang.String objectStoreID,
                                   java.lang.String[] documentID)
                            throws java.lang.Exception
Delete the selected version from the version series object.

Parameters:
objectStoreID - GUID or Name of the Object Store.
documentID - An array of selected document ids.
Returns:
Map A map of all Exception objects key by document id.
Throws:
java.lang.Exception - If there any errors occur.

getSecurityTemplateXML

public org.w3c.dom.Document getSecurityTemplateXML(java.lang.String objectStoreID,
                                                   java.lang.String securityPolicyID,
                                                   boolean refresh)
                                            throws java.lang.Exception
Returns the requested security template xml. Cached data will be stored in module property bag identified by SEC_TEMPLATE + objectStoreID + securityPolicyID.

Parameters:
objectStoreID - GUID format of Object Store ID.
securityPolicyID - GUID format of the security policy ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getSecurityPolicyID

public java.lang.String getSecurityPolicyID(java.lang.String objectStoreID,
                                            java.lang.String objectID,
                                            int objectType)
                                     throws java.lang.Exception
Return the security policy object ID from specified object ID.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID
objectType - Object Id's object type.
Returns:
String GUID format of the security policy object ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getSecurityPoliciesXML

public org.w3c.dom.Document getSecurityPoliciesXML(java.lang.String objectStoreID,
                                                   boolean refresh)
                                            throws java.lang.Exception
Returns the requested security polices xml. Cached data will be stored in module property bag identified by SEC_POLICIES + objectStoreID + securityPolicyClassID.

Parameters:
objectStoreID - GUID format of Object Store ID.
refresh - When set to true, data provider will attempt to get data from server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getSecurityRight

public boolean getSecurityRight(java.lang.String objectStoreID,
                                java.lang.String objectID,
                                int objectType,
                                long accessMask,
                                java.lang.String collectionType)
                         throws java.lang.Exception
This method returns a Boolean value back indicating current user has right by accessMask. Valid accessMask is defined in WcmSecurityUtil.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
objectType - Object ID's object type.
accessMask - access rights
collectionType - Must be the name of a property whose value is a collection of Content Engine Permission objects (not including any properties whose value is a collection of Content Engine AuditPermission objects). Property.PERMISSIONS for basic object permissions.
Returns:
boolean True if user has right, False otherwise.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getSecurityRight

public boolean getSecurityRight(java.lang.String objectStoreID,
                                java.lang.String objectID,
                                int objectType,
                                long accessMask,
                                boolean refresh)
                         throws java.lang.Exception
This method returns a Boolean value back indicating current user has right by accessMask. Valid accessMask is defined in WcmSecurityUtil.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
objectType - Object ID's object type.
accessMask - access rights
refresh - When set to true, data provider will attempt to get mask from server and disregard cached data.
Returns:
boolean True if user has right, False otherwise.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

isInstantiableByUser

public boolean isInstantiableByUser(java.lang.String objectStoreID,
                                    java.lang.String classType)
                             throws java.lang.Exception
Tells you if this class is instantiable by the current user

Parameters:
objectStoreID - object store of the class
classType - The Class Description type
Returns:
true if the class is instantiable
Throws:
java.lang.Exception

getUserAccess

public int getUserAccess(java.lang.String objectStoreID,
                         java.lang.String objectID,
                         int objectType,
                         boolean refresh)
                  throws java.lang.Exception
This method returns the access rights (permissions) of the specified type for the current user on the selected object

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
objectType - Object ID's object type.
refresh - When set to true, data provider will attempt to get mask from server and disregard cached data.
Returns:
int A Permissions collection of the specified type containing the access rights for the current user on the selected object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter. todo: Change Security policy and Workflow Subscription object calls when getAccessMask method is available on both.

getUserAccess

public int getUserAccess(java.lang.String objectStoreID,
                         java.lang.String objectID,
                         int objectType,
                         java.lang.String collectionType)
                  throws java.lang.Exception
This method returns the access rights (permissions) of the specified type for the current user on the selected object

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
objectType - Object ID's object type.
collectionType - Must be the name of a property whose value is a collection of Content Engine Permission objects (not including any properties whose value is a collection of Content Engine AuditPermission objects). Property.PERMISSIONS for basic object permissions.
Returns:
int A Permissions collection of the specified type containing the access rights for the current user on the selected object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

documentHasContent

public boolean documentHasContent(java.lang.String objectStoreID,
                                  java.lang.String objectID)
                           throws java.lang.Exception
This method returns a Boolean value back indicating that there is content in the first content element of the document.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
Returns:
boolean True if there is content, False otherwise.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getDocumentContentCount

public int getDocumentContentCount(java.lang.String objectStoreID,
                                   java.lang.String objectID)
                            throws java.lang.Exception
This method returns the number of document contains contents.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Object ID.
Returns:
boolean True if there is content, False otherwise.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getPropertyDescriptionValue

public java.lang.Object getPropertyDescriptionValue(java.lang.String objectStoreID,
                                                    java.lang.String classID,
                                                    java.lang.String symbolicName,
                                                    java.lang.String propId)
                                             throws java.lang.Exception
Returns the Property Description's Property Value

Parameters:
objectStoreID - The Object Store
classID - The Class Description Id
symbolicName - The Property Description's symbolic name
propId - The symbolic name of the Property Description's Property
Returns:
The Property Description's Property Value
Throws:
java.lang.Exception

getPropertyValue

public java.util.Hashtable getPropertyValue(java.lang.String objectStoreID,
                                            java.lang.String objectID,
                                            int objectType,
                                            java.lang.String[] propIDs)
                                     throws java.lang.Exception
Return object's selected property.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object ID's object type.
propIDs - A collection of property name.
Returns:
Hashtable Return requested properties in name and value-pair format. Null means operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getNamePropertyFromProperties

public java.lang.String getNamePropertyFromProperties(java.lang.String nameProperty)
                                               throws java.lang.Exception
Return name property from properties collection. This method's required properties DOM object resides in class property bag.

Parameters:
nameProperty - name property, typically used for the objects label.
Returns:
String Name.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getLifecycleStates

public java.lang.String[] getLifecycleStates(java.lang.String objectStoreID,
                                             java.lang.String documentID)
                                      throws java.lang.Exception
Return life cycle states from object store.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Returns:
String[] String representation of states.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setLifecycleState

public boolean setLifecycleState(java.lang.String objectStoreID,
                                 java.lang.String documentID,
                                 int state)
                          throws java.lang.Exception
Set a document's life cycle state.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
state - Possible value; STATE_PROMOTE = 1 or STATE_DEMOTE = 2.
Returns:
boolean Operation successful or not.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getReservationID

public java.lang.String getReservationID(java.lang.String objectStoreID,
                                         java.lang.String documentID)
                                  throws java.lang.Exception
Return reservation object ID from specified document ID.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID
Returns:
String GUID format of reveration object ID.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getFilename

public java.lang.String getFilename(java.lang.String objectStoreID,
                                    java.lang.String documentID)
                             throws java.lang.Exception
Return document's file name.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of document ID.
Returns:
String File name, if any.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getCurrentVersionDocID

public java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID,
                                               java.lang.String vsID)
                                        throws java.lang.Exception
Use version series id to retrieve current version document id.

Parameters:
objectStoreID - GUID format of Object Store ID.
vsID - GUID format of Version series ID.
Returns:
String Current verion of document ID
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getCurrentVersionDocID

public java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID,
                                               java.lang.String objectID,
                                               int objectType)
                                        throws java.lang.Exception
Return the current version ID

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object ID's object type.
Returns:
String The ID of the latest document version
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

getCurrentMajorVersionDocID

public java.lang.String getCurrentMajorVersionDocID(java.lang.String objectStoreID,
                                                    java.lang.String vsID)
                                             throws java.lang.Exception
Use version series id to retrieve current released major version document id.

Parameters:
objectStoreID - GUID format of Object Store ID.
vsID - GUID format of Version series ID.
Returns:
String Current verion of document ID
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getVersionSeriesIDFromDocID

public java.lang.String getVersionSeriesIDFromDocID(java.lang.String objectStoreID,
                                                    java.lang.String docID)
                                             throws java.lang.Exception
Return version series id from document id.

Parameters:
objectStoreID - GUID format of Object Store ID.
docID - GUID format of Document ID.
Returns:
String GUID format of Version Series ID
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getVersionStatusLookups

public java.lang.String[] getVersionStatusLookups(java.lang.String objectStoreID)
                                           throws java.lang.Exception
Returns the version status labels. Data is refreshed every 30 minutes.

Parameters:
objectStoreID - GUID format of Object Store ID.
Returns:
String[] Version Status Labels
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getWorkflowSubscriptionXML

public org.w3c.dom.Document getWorkflowSubscriptionXML(java.lang.String objectStoreID,
                                                       java.lang.String objectID,
                                                       boolean refresh)
                                                throws java.lang.Exception
Return workflow subscription in XML format.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
refresh - When set to true, data provider will attempt to get data from the server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception

getWorkflowSubscriptionsXML

public org.w3c.dom.Document getWorkflowSubscriptionsXML(java.lang.String objectStoreID,
                                                        java.lang.String objectID,
                                                        int objectType,
                                                        int isolatedRegion,
                                                        boolean getAllSubscriptions,
                                                        java.lang.String[] propIDs,
                                                        boolean refresh)
                                                 throws java.lang.Exception
Get object's workflow subscriptions.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of Document ID.
objectType - Object ID's object type.
isolatedRegion - Isolated Region number.
getAllSubscriptions - Return all subscriptions related to document and doc class if value is true. Return doc class related subscriptions if value is false.
propIDs - String array of property id.
refresh - When set to true, data provider will attempt to get data from the server and disregard cached data.
Returns:
Document Wrap returning XML string in document object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

isDocument

public boolean isDocument(java.lang.String objectStoreID,
                          java.lang.String ID)
                   throws java.lang.Exception
Used to tell if a class description is derived from the document class

Parameters:
objectStoreID - The object store the class description is from
ID - The id of the class description
Returns:
True if the class is derived from document
Throws:
java.lang.Exception

isFolder

public boolean isFolder(java.lang.String objectStoreID,
                        java.lang.String ID)
                 throws java.lang.Exception
Used to tell if a class description is derived from a folder class

Parameters:
objectStoreID - The object store the class description is from
ID - The id of the class description
Returns:
True if the class is derived from folder
Throws:
java.lang.Exception

isLink

public boolean isLink(java.lang.String objectStoreID,
                      java.lang.String ID)
               throws java.lang.Exception
Used to tell if a class description is derived from a link class

Parameters:
objectStoreID - The object store the class description is from
ID - The id of the class description
Returns:
True if the class is derived from Link
Throws:
java.lang.Exception

isFiled

public boolean isFiled(java.lang.String objectStoreID,
                       java.lang.String objectID,
                       int objectType)
                throws java.lang.Exception
Used to tell if the object is filed in a folder

Parameters:
objectStoreID - The object store the class description is from
objectID - The id of the object
objectType - The Object type
Returns:
True if the object is filed in a folder.
Throws:
java.lang.Exception

isCheckedOut

public boolean isCheckedOut(java.lang.String objectStoreID,
                            java.lang.String documentID)
                     throws java.lang.Exception
Used to tell if a document is checked out.

Parameters:
objectStoreID - The object store the class description is from
documentID - The id of the document
Returns:
True if the document is checked out.
Throws:
java.lang.Exception

isCheckedOutByCurrenUser

public boolean isCheckedOutByCurrenUser(java.lang.String objectStoreID,
                                        java.lang.String objectID,
                                        int objectType)
                                 throws java.lang.Exception
Return true if the document is currently checked out by the login user.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's object type.
Returns:
String GUID format of new checkout document.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

isSubclassOf

public boolean isSubclassOf(java.lang.String objectStoreID,
                            java.lang.String objectID,
                            int objectType,
                            java.lang.String classObjectStore,
                            java.lang.String className)
                     throws java.lang.Exception
Returns true if the given object has a class ID that is the same as the given class's ID or one of its descendants The class ID is retrieved from the object store where it was defined, then compared on the object's object store.

Parameters:
objectStoreID - Object store of object to check
objectID - Id of object to check
objectType - Object type of object to check
classObjectStore - Object store of class to check
className - Symbolic name of class to check
Returns:
true if the class ID matches the given class's ID or one of its descendants
Throws:
java.lang.Exception

isSubclassOf

public boolean isSubclassOf(java.lang.String objectStoreID,
                            java.lang.String objectID,
                            int objectType,
                            java.lang.String parentClass)
                     throws java.lang.Exception
Check to see if object's class is the same or a sub-class of prarent class.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of an object ID.
objectType - Object ID's object type.
parentClass - GUID format of class id.
Returns:
true if object's class is the sub-class of parent class.
Throws:
java.lang.Exception

isSubclassOf

public boolean isSubclassOf(java.lang.String objectStoreID,
                            java.lang.String parentClass,
                            java.lang.String testClass)
                     throws java.lang.Exception
Test if testClass is a subclass of parentClass

Parameters:
objectStoreID - Object store of classes
parentClass - Possible parent class
testClass - Possible subclass
Returns:
true if testClass is a subclass of parentClass
Throws:
java.lang.Exception - Throw exception on error

addSecurityPolicy

public java.lang.String addSecurityPolicy(java.lang.String objectStoreID)
                                   throws java.lang.Exception
Add Security Policy. All parameter are from XML stored in WcmAuthoringStateKeys.PROPERTIES_KEY

Parameters:
objectStoreID - object store to add the new policy to.
Returns:
new Security Policy Id
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setSecurityPolicyProperties

public java.lang.String setSecurityPolicyProperties(java.lang.String objectStoreID,
                                                    java.lang.String policyId)
                                             throws java.lang.Exception
Set the properties on a security Policy. All parameter are from XML stored in WcmAuthoringStateKeys.PROPERTIES_KEY

Parameters:
objectStoreID - object store where the policy resides.
policyId - the policy id
Returns:
policyId the policy id
Throws:
java.lang.Exception

getLinkClassId

public java.lang.String getLinkClassId(java.lang.String objectStoreName,
                                       java.lang.String objectId)
                                throws java.lang.Exception
Returns the Link Class Id

Parameters:
objectStoreName - Object store of specified link object
objectId - Link Object Id
Returns:
The link Class Id
Throws:
java.lang.Exception

checkLinkClass

public boolean checkLinkClass(java.lang.String objectStoreName,
                              java.lang.String classId,
                              java.lang.String[] linkClassIDs,
                              boolean[] subClasses,
                              boolean[] operation)
                       throws java.lang.Exception
Check the class to see if the given operation is allowed

Parameters:
objectStoreName - obejct store of class
classId - Id of class
linkClassIDs - class IDs from site preferences
subClasses - include subclass boolean array from site preferences
operation - operation boolean array we want to check
Returns:
true if the operation is allowed on this class
Throws:
java.lang.Exception

createLink

public java.lang.String createLink()
                            throws java.lang.Exception
Create a link object

Returns:
link ID
Throws:
java.lang.Exception

createLink

public java.lang.String createLink(java.lang.String objectStoreID,
                                   java.lang.String classId,
                                   java.lang.String head,
                                   java.lang.String tail,
                                   boolean cascadeDelete,
                                   com.filenet.wcm.api.Properties properties)
                            throws java.lang.Exception
Integration mode: create a link between documents

Parameters:
objectStoreID -
classId - - link class
head - - id of the head document
tail - - id of the tail document
cascadeDelete - - true to enforce cascade delete
properties - - additional properties for extensibility
Returns:
Throws:
java.lang.Exception

getHeadLinksXML

public org.w3c.dom.Document getHeadLinksXML(java.lang.String objectStoreID,
                                            java.lang.String objectID,
                                            int objectType,
                                            java.lang.String[] propNames,
                                            boolean refresh)
                                     throws java.lang.Exception
Get the Head Links XML on a Base Object

Parameters:
objectStoreID - The name of the object store where the base object lives
objectID - The id of the base object
objectType - The object type of the base object
propNames - The property names to include in the XML
refresh - Use cache or refresh from server
Returns:
Returns the XML of the head links
Throws:
java.lang.Exception - Exception

getTailLinksXML

public org.w3c.dom.Document getTailLinksXML(java.lang.String objectStoreID,
                                            java.lang.String objectID,
                                            int objectType,
                                            java.lang.String[] propNames,
                                            boolean refresh)
                                     throws java.lang.Exception
Get the Tail Links XML on a Base Object

Parameters:
objectStoreID - The name of the object store where the base object lives
objectID - The id of the base object
objectType - The object type of the base object
propNames - The property names to include in the XML
refresh - Use cache or refresh from server
Returns:
Returns the XML of the tail links
Throws:
java.lang.Exception - Exception

addWorkflowSubscription

public java.lang.String addWorkflowSubscription()
                                         throws java.lang.Exception
Add workflow subscriptions. All parameter are from XML stored in PROPERTIES_KEY

Returns:
new Subscription Id
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

setSortParameters

public void setSortParameters(java.lang.String folderNameProperty,
                              java.lang.String documentNameProperty)
This setup the property to be sorted by in certain XML get method. 1.) getActiveUserCheckoutList

Parameters:
folderNameProperty - Folder sorted-by property name.
documentNameProperty - Document sorted-by property name.

canCheckInAsMajorVersion

public boolean canCheckInAsMajorVersion(java.lang.String objectStoreID,
                                        java.lang.String documentID)
                                 throws java.lang.Exception
This method determines if the authenticated user can checkin a checked out document as a new released version.

Parameters:
objectStoreID - Object store name
documentID - Document Id
Returns:
true, if user can checkin the document as a new released version
Throws:
java.lang.Exception

canCheckIn

public boolean canCheckIn(java.lang.String objectStoreID,
                          java.lang.String documentID)
                   throws java.lang.Exception
This method determines if the authenticated user can checkin a checked out document.

Parameters:
objectStoreID - Object store name
documentID - Document Id
Returns:
true, if user can checkin the document
Throws:
java.lang.Exception

canCancelCheckout

public boolean canCancelCheckout(java.lang.String objectStoreID,
                                 java.lang.String documentID)
                          throws java.lang.Exception
This method determines if the authenticated user can cancel checkout the checked out document.

Parameters:
objectStoreID - Object store name
documentID - Document Id
Returns:
true, if user can cancel checkout the document
Throws:
java.lang.Exception

changeObjectClass

public boolean changeObjectClass(java.lang.String objectStoreID,
                                 java.lang.String objectID,
                                 java.lang.String classID,
                                 int objectType)
                          throws java.lang.Exception
This method change object to new class with new properties. Permissions is not in consideration for now.

Parameters:
objectStoreID - Object store name
objectID - Object name
classID - New class id.
objectType - Object type
Returns:
true, if operation success or false.
Throws:
java.lang.Exception

getMultiTransferElementList

public java.util.List getMultiTransferElementList(java.lang.String objectStoreID,
                                                  java.lang.String documentID)
                                           throws java.lang.Exception
Return document's content in a list of TransportInputStream. This method does not return external reference object.

Parameters:
objectStoreID - GUID format of Object Store ID.
documentID - GUID format of Document ID.
Returns:
List list of TransportInputStream.
Throws:
java.lang.Exception - if there are problems retrieving data or with an invalid parameter.

isWebFolder

public boolean isWebFolder(java.lang.String objectStoreID,
                           java.lang.String objectID)
                    throws java.lang.Exception
Deprecated. This method has been deprecated you should use new method from WebContentDataProvider.

Examine if current folder is a WebDocFolder.

Parameters:
objectStoreID - Object store name.
objectID - Current folder id.
Returns:
ture or false
Throws:
java.lang.Exception

setProperty

public boolean setProperty(java.lang.String objectStoreID,
                           java.lang.String objectID,
                           int objectType,
                           java.lang.String sID,
                           java.lang.Object o)
                    throws java.lang.Exception
Save a single property for the specified object.

Parameters:
objectStoreID - GUID format of Object Store ID.
objectID - GUID format of object ID.
objectType - Object Id's Object type.
sID - Property name.
o - Property value.
Returns:
boolean true if set object property is success, false otherwise.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getSession

protected com.filenet.wcm.api.Session getSession()
                                          throws java.lang.Exception
Return logon session object from dataStore. Exception will be thrown if session is not logged on.

Returns:
Session Logon session object.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

createProperties

public com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName,
                                                       org.w3c.dom.NodeList propertiesNodeList)
                                                throws java.lang.Exception
Create a JavaAPI's Properties from XML node list Each node must have children nodes of SYMNAME, STATE, and VALUE/VALUES We only pick node that has state marked as modify to avoid problem of sending back read only property.

Parameters:
objectStoreName - Object Store Name for Object Valued Properties.
propertiesNodeList - Property XML node.
Returns:
Properties JavaAPI's Properties collection. Null means operation failed.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

createPermissions

public com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList,
                                                         boolean replaceCreatorOwner)
                                                  throws java.lang.Exception
Create a JavaAPI's Permissions from XML node list Each node must have children nodes of GRANTEENAME, GRANTETYPE, ACCESSTYPE, ACCESS with or without STATE If State is specified and its value is WcmSecurityUtil.REMOVED then we don't send back those node to signal it has been removed from permission list. Without those node from begin achieve same goal.

Parameters:
permissionsNodeList - Permissions XML node.
replaceCreatorOwner - true to replace the #CREATOR OWNER with the current authenticated user.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

checkParam

protected static boolean checkParam(java.lang.Object o)
                             throws java.lang.Exception
Make sure object is not null and has some value. For now it only works with String type.

Parameters:
o - XML object key name.
Returns:
boolean Return true if object is a string and not null.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getXMLDocument

protected org.w3c.dom.Document getXMLDocument(java.lang.String xml,
                                              java.lang.String key)
                                       throws java.lang.Exception
Pack XML string into a Document object and cache it into a window property to speed up future data retrival time.

Parameters:
xml - XML string.
key - A value to be stored in property bag.
Returns:
boolean XML Document object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

getXMLDocumentByClass

protected org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml,
                                                     java.lang.String key)
                                              throws java.lang.Exception
Pack XML string into a Document object and cache it into class property bag to speed up future data retrival time. This will cache across popup window boundaries if you know you are forcing refresh outside of WcmAuthoringDataProvider correctly. Requires using getClassProperty in calling methods. Use with care.

Parameters:
xml - XML string.
key - A value to be stored in property bag.
Returns:
boolean XML Document object
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.