com.filenet.rm.api
Interface GuideContainer
All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
All known subinterfaces:
- public interface GuideContainer
- extends com.filenet.wcm.api.Folder
GuideSection
and
GuideTopic
objects. The GuideContainer
interface extends the Content Engine
Folder
interface.
Field Summary
Fields inherited from interface com.filenet.wcm.api.BaseObject |
---|
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT |
Method Summary
Modifier and Type | Method and Description |
---|---|
addGuideSection(java.lang.String asGuideSectionName,java.lang.String asClassID,com.filenet.wcm.api.Properties aoSectionProps,com.filenet.wcm.api.Permissions aoSectionACLs)
Adds a new
GuideSection object to the hierarchy at the current level.
|
|
addGuideTopic(java.lang.String asGuideTopicName,java.lang.String asClassID,com.filenet.wcm.api.Properties aoTopicProps,com.filenet.wcm.api.Permissions aoSectionACLs)
Adds a new
GuideTopic object to the hierarchy at the current level.
|
|
|
delete()
|
getGuideSections()
Returns the
GuideSection objects at the current level of the hierarchy.
|
|
getGuideSections(java.lang.String[] asPropNames)
Returns the
GuideSection objects at the current level of the hierarchy along with
the values of the specified properties.
|
|
|
getGuideSectionsXML(java.lang.String[] asPropNames)
Returns an XML string containing the
GuideSection objects at the current level
of the hierarchy along with the values of the specified properties.
|
getGuideTopics()
Returns the
GuideTopic objects at the current level of the hierarchy.
|
|
getGuideTopics(java.lang.String[] asPropNames)
Returns the
GuideTopic objects at the current level of the hierarchy along with
the values of the specified properties.
|
|
|
getGuideTopicsXML(java.lang.String[] asPropNames)
Returns an XML string containing the
GuideTopic objects at the current level
of the hierarchy along with the values of the specified properties.
|
|
update(com.filenet.wcm.api.Properties aoProps)
Updates properties for a guide or a guide section and ensures that the guide name
is not duplicated due to the update.
|
Methods inherited from interface com.filenet.wcm.api.Folder |
---|
addSubFolder, addSubFolder, applySecurityTemplate, changeClass, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, move, raiseEvent |
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget |
---|
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
---|
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
---|
setProperties, setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
---|
getAccessMask, getPermissions, getPermissions |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
---|
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
---|
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Methods inherited from interface com.filenet.wcm.api.LockableObject |
---|
extendLock, extendLock, isLocked, lock, unlock, unlock |
Method Detail
addGuideSection
- GuideSection addGuideSection(java.lang.String asGuideSectionName,
- java.lang.String asClassID,
- com.filenet.wcm.api.Properties aoSectionProps,
- com.filenet.wcm.api.Permissions aoSectionACLs)
- throws RMException
Parameters:
asGuideSectionName
- A String
representing the name to be given to
the new GuideSection
object. asClassID
- A String
representing either the class name or ID for
the new GuideSection
object. By default, the base class name is used
if this parameter is null. aoSectionProps
- A Properties
collection containing the property values
to be used for the new GuideSection
object.
The values include the topic property values that can be associated
with a GuideSection
object. aoSectionACLs
- A Permissions
collection containing the permission values
to be used for the new GuideSection
object. Returns:
A
GuideSection
object. Throws:
RMException
- If a Records Manager error occurs. getGuideSections
- GuideSections getGuideSections( )
- throws RMException
Returns the
GuideSection
objects at the current level of the hierarchy.
Returns:
A
GuideSections
collection containing the GuideSection
objects at the current level of the hierarchy. Throws:
RMException
- If a Records Manager error occurs. getGuideSections
- GuideSections getGuideSections( java.lang.String[] asPropNames)
- throws RMException
Returns the
GuideSection
objects at the current level of the hierarchy along with
the values of the specified properties.
Parameters:
asPropNames
- A String
array identifying the properties to be returned. Returns:
A
GuideSections
collection containing the GuideSection
objects at the current level of the hierarchy along with the specified properties. Throws:
RMException
- If a Records Manager error occurs. getGuideSectionsXML
- java.lang.String getGuideSectionsXML( java.lang.String[] asPropNames)
- throws RMException
Returns an XML string containing the
GuideSection
objects at the current level
of the hierarchy along with the values of the specified properties.
Parameters:
asPropNames
- A String
array identifying the properties to be returned. Returns:
An
String
GuideSection
objects at the current level of the hierarchy along with the specified properties. Throws:
RMException
- If a Records Manager error occurs. addGuideTopic
- GuideTopic addGuideTopic(java.lang.String asGuideTopicName,
- java.lang.String asClassID,
- com.filenet.wcm.api.Properties aoTopicProps,
- com.filenet.wcm.api.Permissions aoSectionACLs)
- throws RMException
Adds a new
GuideTopic
object to the hierarchy at the current level.
Parameters:
asGuideTopicName
- A String
representing the name to be given to
the new GuideTopic
object. asClassID
- A String
representing either the class name or ID for
the new GuideTopic
object. By default, the base class name is used
if this parameter is null. aoTopicProps
- A Properties
collection containing the property values
to be used for the new GuideTopic
object.
The values include the topic property values that can be associated
with a GuideTopic
object. aoSectionACLs
- A Permissions
collection containing the permission values
to be used for the new GuideTopic
object. Returns:
A
GuideTopic
object. Throws:
RMException
- If a Records Manager error occurs. getGuideTopics
- GuideTopics getGuideTopics()
- throws RMException
Returns the
GuideTopic
objects at the current level of the hierarchy.
Returns:
A
GuideTopics
collection containing the GuideTopic
objects at the current level of the hierarchy. Throws:
RMException
- If a Records Manager error occurs. getGuideTopics
- GuideTopics getGuideTopics(java.lang.String[] asPropNames)
- throws RMException
Returns the
GuideTopic
objects at the current level of the hierarchy along with
the values of the specified properties.
Parameters:
asPropNames
- A String
array identifying the properties to be returned. Returns:
A
GuideTopics
collection containing the GuideTopic
objects at the current level of the hierarchy along with the specified properties. Throws:
RMException
- If a Records Manager error occurs. getGuideTopicsXML
- java.lang.String getGuideTopicsXML( java.lang.String[] asPropNames)
- throws RMException
Returns an XML string containing the
GuideTopic
objects at the current level
of the hierarchy along with the values of the specified properties.
Parameters:
asPropNames
- A String
array identifying the properties to be returned. Returns:
A
String
GuideTopic
objects at the current level of the hierarchy along with the specified properties. Throws:
RMException
- If a Records Manager error occurs. delete
- void delete()
- throws RMException
Deletes a
GuideSection
or GuideTopic
object from
this GuideContainer
object. The method also deletes any subtopics or
subsections.
Specified by:
delete
in interface com.filenet.wcm.api.Folder
Throws:
RMException
- If a Records Manager error occurs. update
- void update(com.filenet.wcm.api.Properties aoProps)
- throws RMException
Updates properties for a guide or a guide section and ensures that the guide name
is not duplicated due to the update.
Parameters:
aoProps
- A Properties
collection that contains the properties
to be updated. Throws:
RMException
- If a Records Manager error occurs.
GuideSection
object to the hierarchy at the current level.