|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.WcmDpModule
com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider
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 |
public static final int TYPE_DOCUMENT
public static final int TYPE_FOLDER
public static final int TYPE_OBJECT_STORE
public static final int TYPE_CLASSDESCRIPTION
public static final int TYPE_STORED_SEARCH
public static final int TYPE_SECURITY_POLICY
public static final int TYPE_PUBLISH_TEMPLATE
public static final int TYPE_VERSIONSERIES
public static final int TYPE_CUSTOMOBJECT
public static final int TYPE_WORKFLOW_CLASS_SUBSCRIPTION
public static final int TYPE_WORKFLOWDEFINITION
public static final int TYPE_LINK
public static final int STATE_PROMOTE
public static final int STATE_DEMOTE
public static final int STATE_SET_EXCEPTION
public static final int STATE_CLEAR_EXCEPTION
public static final int STATE_RESET
public static final int PRINCIPAL_SEARCH_TYPE_NONE
public static final int PRINCIPAL_SEARCH_TYPE_CUSTOM
public static final int PRINCIPAL_SEARCH_TYPE_PREFIX_MATCH
public static final int PRINCIPAL_SEARCH_TYPE_SUFFIX_MATCH
public static final int PRINCIPAL_SEARCH_TYPE_CONTAINS
public static final int PRINCIPAL_SEARCH_TYPE_EXACT
public static final int PRINCIPAL_SEARCH_SORT_NONE
public static final int PRINCIPAL_SEARCH_SORT_ASCENDING
public static final int PRINCIPAL_SEARCH_SORT_DESCENDING
public static final int PRINCIPAL_SEARCH_ATTR_NONE
public static final int PRINCIPAL_SEARCH_ATTR_SHORT_NAME
public static final int PRINCIPAL_SEARCH_ATTR_DISPLAY_NAME
public static final int RESERVATION_TYPE_COLLABORATIVE
public static final int RESERVATION_TYPE_DEFAULT
public static final int RESERVATION_TYPE_EXCLUSIVE
public static final java.lang.String PROPERTY_STATE_NOT_CHANGED
public static final java.lang.String PROPERTY_STATE_MODIFIED
public static final java.lang.String PROPERTY_STATE_NOT_VALIDATED
public static final java.lang.String TYPE
Constructor Detail |
public WcmAuthoringDataProvider() throws java.lang.Exception
java.lang.Exception
public WcmAuthoringDataProvider(java.lang.String name) throws java.lang.Exception
name
- Module name
java.lang.Exception
Method Detail |
public void clearCache(java.lang.String objectStoreName, java.lang.String objectId, int mode, int objectType, java.lang.String[] parentIds) throws java.lang.Exception
java.lang.Exception
public java.lang.String getDocumentURL(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getDocumentVersions(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public java.lang.String getObjectStoreId(java.lang.String objectStoreName) throws java.lang.Exception
objectStoreName
- String holding the object store name
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int objectType, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, int objectType, java.util.Set excludedClasses, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getSingleClassDescription(java.lang.String objectStoreID, java.lang.String classDescsId, int objectType) throws java.lang.Exception
objectStoreID
- classDescsId
- objectType
-
java.lang.Exception
public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, java.lang.String[] classDescs, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectStoreClasses(java.lang.String objectStoreID, java.lang.String[] classDescs, java.util.Set excludedClasses, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getClassProperties(java.lang.String objectStoreID, java.lang.String classID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectStorePropertyDescriptions(java.lang.String objectStoreID, int objectType, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public static java.lang.String readFromFile(java.lang.String sFileName)
sFileName
-
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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean setWorkflowSubscriptionProperties(java.lang.String objectID) throws java.lang.Exception
objectID
- GUID of the workflow subscription.
java.lang.Exception
- If there any errors occur.public boolean setProperties(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's Object type.
java.lang.Exception
- If there were problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getClassPermissions(java.lang.String objectStoreID, java.lang.String classID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getObjectPermissions(java.lang.String objectStoreID, java.lang.String objectID, int objectType, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean setObjectPermissions(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getRealmsList(boolean refresh) throws java.lang.Exception
refresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getRealmGroups(java.lang.String realmId, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getRealmUsers(java.lang.String realmId, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 collectionrefresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 collectionrefresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document mergeRealmUsers(boolean refresh) throws java.lang.Exception
refresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document mergeRealmGroups(boolean refresh) throws java.lang.Exception
refresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID, java.lang.String[] propIDs, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getActiveUserCheckedOutList(java.lang.String objectStoreID, java.lang.String[] propIDs, java.lang.String[] mimeTypes, boolean refresh) throws java.lang.Exception
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 XMLrefresh
- When set to true, data provider will attempt to get data from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Document ID.objectType
- Object type.properties
- org.w3c.dom.Document holding property valuespermissions
- org.w3c.dom.Document holding security settingsdocumentContents
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Document ID.properties
- org.w3c.dom.Document holding property valuespermissions
- org.w3c.dom.Document holding security settingsexternalReference
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public com.filenet.wcm.api.TransportInputStream getDocumentElement(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int element) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Document ID.objectType
- Object type.element
- Which element to put the content into.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public void deleteDocumentElement(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int element) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 valuespermissions
- org.w3c.dom.Document holding security settingsdocumentContents
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 referenceminorVersion
- Is this the minor version.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 valuespermissions
- org.w3c.dom.Document holding security settingsmimeType
- documentContent's MIME type. If not null this will be MIME type of documentContents.minorVersion
- Is this the minor version.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
objectStoreID
- Object Store ID.folderID
- Folder ID where document to file in.classID
- Class ID.externalReference
- A URL format of external referencemimeType
- Mime Type of the external referenceminorVersion
- Is this the minor version.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public com.filenet.wcm.api.TransportInputStream doDownloadDocument(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public void demoteVersion(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public void promoteVersion(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String doCheckoutDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String doCheckoutDocument(java.lang.String objectStoreID, java.lang.String objectID, int objectType, int reservationType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's object type.reservationType
- int the reservation type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.util.Map doCheckoutDocument(java.lang.String objectStoreID, java.lang.String vsID, java.lang.String[] propIDs) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.vsID
- GUID format of Version series ID.propIDs
- A collection of property name.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean doCopyToAnotherFolder(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String objID, int objectType) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean doUnfileObject(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String objID, int objectType) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public void doMoveFolder(java.lang.String objectStoreID, java.lang.String objID, java.lang.String destinationFolderID) throws java.lang.Exception
objectStoreID
- Object Store ID.objID
- GUID format of Document ID.destinationFolderID
- Destination Folder ID
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getCurrentPublishingDocument(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getPublishingTemplate(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String[] propIDs, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean setPublishingTemplate(java.lang.String objectStoreID, java.lang.String documentID, java.lang.String templateID, java.lang.String name) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean doRepublish(java.lang.String objectStoreID, java.lang.String sourceDocID, java.lang.String publishDocID, java.lang.String name) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getPropertyChoiceList(java.lang.String objectStoreID, java.lang.String cvlValueID, int depth, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String addCustomObject(java.lang.String objectStoreID, java.lang.String folderID, java.lang.String classID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.folderID
- GUID format of parent folder ID.classID
- GUID format of Custom Object's class ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 valuespermissions
- org.w3c.dom.Document holding security settings
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean doCancelCheckout(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 typeremoveRootFolder
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
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 typeremoveRootFolder
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getRootFolderID(java.lang.String objectStore) throws java.lang.Exception
objectStore
-
java.lang.Exception
public boolean deleteWorkflowSubscription(java.lang.String objectStoreID, java.lang.String objectID) throws java.lang.Exception
objectStoreID
- GUID or Name of the Object Store.objectID
- GUID of the workflow subscription.
java.lang.Exception
- If there any errors occur.public void deleteObject(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID or Name of the Object Store.objectID
- GUID format of an object id.objectType
- Object Id's object type.
java.lang.Exception
- If there any errors occur.public java.util.Map deleteVersion(java.lang.String objectStoreID, java.lang.String[] documentID) throws java.lang.Exception
objectStoreID
- GUID or Name of the Object Store.documentID
- An array of selected document ids.
java.lang.Exception
- If there any errors occur.public org.w3c.dom.Document getSecurityTemplateXML(java.lang.String objectStoreID, java.lang.String securityPolicyID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getSecurityPolicyID(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object IDobjectType
- Object Id's object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getSecurityPoliciesXML(java.lang.String objectStoreID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean getSecurityRight(java.lang.String objectStoreID, java.lang.String objectID, int objectType, long accessMask, java.lang.String collectionType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Object ID.objectType
- Object ID's object type.accessMask
- access rightscollectionType
- 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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean getSecurityRight(java.lang.String objectStoreID, java.lang.String objectID, int objectType, long accessMask, boolean refresh) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Object ID.objectType
- Object ID's object type.accessMask
- access rightsrefresh
- When set to true, data provider will attempt to get mask from server and disregard cached data.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean isInstantiableByUser(java.lang.String objectStoreID, java.lang.String classType) throws java.lang.Exception
objectStoreID
- object store of the classclassType
- The Class Description type
java.lang.Exception
public int getUserAccess(java.lang.String objectStoreID, java.lang.String objectID, int objectType, boolean refresh) throws java.lang.Exception
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.
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.public int getUserAccess(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String collectionType) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean documentHasContent(java.lang.String objectStoreID, java.lang.String objectID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Object ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public int getDocumentContentCount(java.lang.String objectStoreID, java.lang.String objectID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of Object ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
objectStoreID
- The Object StoreclassID
- The Class Description IdsymbolicName
- The Property Description's symbolic namepropId
- The symbolic name of the Property Description's Property
java.lang.Exception
public java.util.Hashtable getPropertyValue(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String[] propIDs) throws java.lang.Exception
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getNamePropertyFromProperties(java.lang.String nameProperty) throws java.lang.Exception
nameProperty
- name property, typically used for the objects label.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String[] getLifecycleStates(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean setLifecycleState(java.lang.String objectStoreID, java.lang.String documentID, int state) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.state
- Possible value; STATE_PROMOTE = 1 or STATE_DEMOTE = 2.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getReservationID(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getFilename(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID, java.lang.String vsID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.vsID
- GUID format of Version series ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getCurrentVersionDocID(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object ID's object type.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public java.lang.String getCurrentMajorVersionDocID(java.lang.String objectStoreID, java.lang.String vsID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.vsID
- GUID format of Version series ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String getVersionSeriesIDFromDocID(java.lang.String objectStoreID, java.lang.String docID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.docID
- GUID format of Document ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String[] getVersionStatusLookups(java.lang.String objectStoreID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public org.w3c.dom.Document getWorkflowSubscriptionXML(java.lang.String objectStoreID, java.lang.String objectID, boolean refresh) throws java.lang.Exception
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.
java.lang.Exception
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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public boolean isDocument(java.lang.String objectStoreID, java.lang.String ID) throws java.lang.Exception
objectStoreID
- The object store the class description is fromID
- The id of the class description
java.lang.Exception
public boolean isFolder(java.lang.String objectStoreID, java.lang.String ID) throws java.lang.Exception
objectStoreID
- The object store the class description is fromID
- The id of the class description
java.lang.Exception
public boolean isLink(java.lang.String objectStoreID, java.lang.String ID) throws java.lang.Exception
objectStoreID
- The object store the class description is fromID
- The id of the class description
java.lang.Exception
public boolean isFiled(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- The object store the class description is fromobjectID
- The id of the objectobjectType
- The Object type
java.lang.Exception
public boolean isCheckedOut(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- The object store the class description is fromdocumentID
- The id of the document
java.lang.Exception
public boolean isCheckedOutByCurrenUser(java.lang.String objectStoreID, java.lang.String objectID, int objectType) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.objectID
- GUID format of object ID.objectType
- Object Id's object type.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.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
objectStoreID
- Object store of object to checkobjectID
- Id of object to checkobjectType
- Object type of object to checkclassObjectStore
- Object store of class to checkclassName
- Symbolic name of class to check
java.lang.Exception
public boolean isSubclassOf(java.lang.String objectStoreID, java.lang.String objectID, int objectType, java.lang.String parentClass) throws java.lang.Exception
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.
java.lang.Exception
public boolean isSubclassOf(java.lang.String objectStoreID, java.lang.String parentClass, java.lang.String testClass) throws java.lang.Exception
objectStoreID
- Object store of classesparentClass
- Possible parent classtestClass
- Possible subclass
java.lang.Exception
- Throw exception on errorpublic java.lang.String addSecurityPolicy(java.lang.String objectStoreID) throws java.lang.Exception
objectStoreID
- object store to add the new policy to.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public java.lang.String setSecurityPolicyProperties(java.lang.String objectStoreID, java.lang.String policyId) throws java.lang.Exception
objectStoreID
- object store where the policy resides.policyId
- the policy id
java.lang.Exception
public java.lang.String getLinkClassId(java.lang.String objectStoreName, java.lang.String objectId) throws java.lang.Exception
objectStoreName
- Object store of specified link objectobjectId
- Link Object Id
java.lang.Exception
public boolean checkLinkClass(java.lang.String objectStoreName, java.lang.String classId, java.lang.String[] linkClassIDs, boolean[] subClasses, boolean[] operation) throws java.lang.Exception
objectStoreName
- obejct store of classclassId
- Id of classlinkClassIDs
- class IDs from site preferencessubClasses
- include subclass boolean array from site preferencesoperation
- operation boolean array we want to check
java.lang.Exception
public java.lang.String createLink() throws java.lang.Exception
java.lang.Exception
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
objectStoreID
- classId
- - link classhead
- - id of the head documenttail
- - id of the tail documentcascadeDelete
- - true to enforce cascade deleteproperties
- - additional properties for extensibility
java.lang.Exception
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
objectStoreID
- The name of the object store where the base object livesobjectID
- The id of the base objectobjectType
- The object type of the base objectpropNames
- The property names to include in the XMLrefresh
- Use cache or refresh from server
java.lang.Exception
- Exceptionpublic 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
objectStoreID
- The name of the object store where the base object livesobjectID
- The id of the base objectobjectType
- The object type of the base objectpropNames
- The property names to include in the XMLrefresh
- Use cache or refresh from server
java.lang.Exception
- Exceptionpublic java.lang.String addWorkflowSubscription() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public void setSortParameters(java.lang.String folderNameProperty, java.lang.String documentNameProperty)
folderNameProperty
- Folder sorted-by property name.documentNameProperty
- Document sorted-by property name.public boolean canCheckInAsMajorVersion(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- Object store namedocumentID
- Document Id
java.lang.Exception
public boolean canCheckIn(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- Object store namedocumentID
- Document Id
java.lang.Exception
public boolean canCancelCheckout(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- Object store namedocumentID
- Document Id
java.lang.Exception
public boolean changeObjectClass(java.lang.String objectStoreID, java.lang.String objectID, java.lang.String classID, int objectType) throws java.lang.Exception
objectStoreID
- Object store nameobjectID
- Object nameclassID
- New class id.objectType
- Object type
java.lang.Exception
public java.util.List getMultiTransferElementList(java.lang.String objectStoreID, java.lang.String documentID) throws java.lang.Exception
objectStoreID
- GUID format of Object Store ID.documentID
- GUID format of Document ID.
java.lang.Exception
- if there are problems retrieving data or with an invalid parameter.public boolean isWebFolder(java.lang.String objectStoreID, java.lang.String objectID) throws java.lang.Exception
objectStoreID
- Object store name.objectID
- Current folder id.
java.lang.Exception
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
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.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected com.filenet.wcm.api.Session getSession() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public com.filenet.wcm.api.Properties createProperties(java.lang.String objectStoreName, org.w3c.dom.NodeList propertiesNodeList) throws java.lang.Exception
objectStoreName
- Object Store Name for Object Valued Properties.propertiesNodeList
- Property XML node.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.public com.filenet.wcm.api.Permissions createPermissions(org.w3c.dom.NodeList permissionsNodeList, boolean replaceCreatorOwner) throws java.lang.Exception
permissionsNodeList
- Permissions XML node.replaceCreatorOwner
- true to replace the #CREATOR OWNER with the current authenticated user.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected static boolean checkParam(java.lang.Object o) throws java.lang.Exception
o
- XML object key name.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected org.w3c.dom.Document getXMLDocument(java.lang.String xml, java.lang.String key) throws java.lang.Exception
xml
- XML string.key
- A value to be stored in property bag.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.protected org.w3c.dom.Document getXMLDocumentByClass(java.lang.String xml, java.lang.String key) throws java.lang.Exception
xml
- XML string.key
- A value to be stored in property bag.
java.lang.Exception
- If there are problems retrieving data or with an invalid parameter.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |