public interface GuideContainer
extends com.filenet.wcm.api.Folder
GuideSection
and
GuideTopic
objects. The GuideContainer
interface extends the Content Engine
Folder
interface.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
Modifier and Type | Method and Description |
---|---|
GuideSection |
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. |
GuideTopic |
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. |
void |
delete()
|
GuideSections |
getGuideSections()
Returns the
GuideSection objects at the current level of the hierarchy. |
GuideSections |
getGuideSections(java.lang.String[] asPropNames)
Returns the
GuideSection objects at the current level of the hierarchy along with
the values of the specified properties. |
java.lang.String |
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. |
GuideTopics |
getGuideTopics()
Returns the
GuideTopic objects at the current level of the hierarchy. |
GuideTopics |
getGuideTopics(java.lang.String[] asPropNames)
Returns the
GuideTopic objects at the current level of the hierarchy along with
the values of the specified properties. |
java.lang.String |
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. |
void |
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.
|
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
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
setPermissions, setPermissions
setProperties, setProperties
getAccessMask, getPermissions, getPermissions
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
GuideSection addGuideSection(java.lang.String asGuideSectionName, java.lang.String asClassID, com.filenet.wcm.api.Properties aoSectionProps, com.filenet.wcm.api.Permissions aoSectionACLs) throws RMException
GuideSection
object to the hierarchy at the current level.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.GuideSection
object.RMException
- If a Records Manager error occurs.GuideSections getGuideSections() throws RMException
GuideSection
objects at the current level of the hierarchy.GuideSections
collection containing the GuideSection
objects at the current level of the hierarchy.RMException
- If a Records Manager error occurs.GuideSections getGuideSections(java.lang.String[] asPropNames) throws RMException
GuideSection
objects at the current level of the hierarchy along with
the values of the specified properties.asPropNames
- A String
array identifying the properties to be returned.GuideSections
collection containing the GuideSection
objects at the current level of the hierarchy along with the specified properties.RMException
- If a Records Manager error occurs.java.lang.String getGuideSectionsXML(java.lang.String[] asPropNames) throws RMException
GuideSection
objects at the current level
of the hierarchy along with the values of the specified properties.asPropNames
- A String
array identifying the properties to be returned.String
GuideSection
objects at the current level of the hierarchy along with the specified properties.RMException
- If a Records Manager error occurs.GuideTopic addGuideTopic(java.lang.String asGuideTopicName, java.lang.String asClassID, com.filenet.wcm.api.Properties aoTopicProps, com.filenet.wcm.api.Permissions aoSectionACLs) throws RMException
GuideTopic
object to the hierarchy at the current level.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.GuideTopic
object.RMException
- If a Records Manager error occurs.GuideTopics getGuideTopics() throws RMException
GuideTopic
objects at the current level of the hierarchy.GuideTopics
collection containing the GuideTopic
objects at the current level of the hierarchy.RMException
- If a Records Manager error occurs.GuideTopics getGuideTopics(java.lang.String[] asPropNames) throws RMException
GuideTopic
objects at the current level of the hierarchy along with
the values of the specified properties.asPropNames
- A String
array identifying the properties to be returned.GuideTopics
collection containing the GuideTopic
objects at the current level of the hierarchy along with the specified properties.RMException
- If a Records Manager error occurs.java.lang.String getGuideTopicsXML(java.lang.String[] asPropNames) throws RMException
GuideTopic
objects at the current level
of the hierarchy along with the values of the specified properties.asPropNames
- A String
array identifying the properties to be returned.String
GuideTopic
objects at the current level of the hierarchy along with the specified properties.RMException
- If a Records Manager error occurs.void delete() throws RMException
GuideSection
or GuideTopic
object from
this GuideContainer
object. The method also deletes any subtopics or
subsections.delete
in interface com.filenet.wcm.api.Folder
RMException
- If a Records Manager error occurs.void update(com.filenet.wcm.api.Properties aoProps) throws RMException
aoProps
- A Properties
collection that contains the properties
to be updated.RMException
- If a Records Manager error occurs.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.