com.filenet.rm.api

Interface GuideSection

All Superinterfaces:

com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, GuideContainer, 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

public interface GuideSection
extends GuideContainer

Represents a section in a classification guide. The GuideSection interface inherits all methods from the base interface and exposes one method for retrieving the top-level classification guide.

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

Methods

Modifier and Type	Method and Description
ClassificationGuide	getClassificationGuide() Returns the top-level classification guide for this GuideSection object.

Methods inherited from interface com.filenet.rm.api.GuideContainer

addGuideSection, addGuideTopic, delete, getGuideSections, getGuideSections, getGuideSectionsXML, getGuideTopics, getGuideTopics, getGuideTopicsXML, 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

getClassificationGuide

ClassificationGuide getClassificationGuide()
                                           throws RMException

Returns the top-level classification guide for this GuideSection object.

Returns:

A ClassificationGuide object representing the top-level classification guide for this object.

Throws:

RMException - If a Records Manager error occurs.