Package com.ptc.windchill.option.model
Class OptionSet
java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._RevisionControlled
wt.enterprise.RevisionControlled
com.ptc.windchill.option.model._OptionSet
com.ptc.windchill.option.model.OptionSet
- All Implemented Interfaces:
com.ptc.windchill.option.model._OptionSetTypeInterface,com.ptc.windchill.option.model.OptionSetTypeInterface,Externalizable,Serializable,wt.access._AccessControlled,wt.access._AccessControlList,wt.access._AdHocControlled,wt.access._PolicyAccessControlled,wt.access._SecurityLabeled,AccessControlled,wt.access.AccessControlList,AdHocControlled,wt.access.PolicyAccessControlled,SecurityLabeled,wt.admin._DomainAdministered,DomainAdministered,wt.change2._Changeable2,wt.change2._ChangeableIfc,Changeable2,ChangeableIfc,wt.content._ContentHolder,ContentHolder,wt.esi._Releasable,Releasable,wt.facade.persistedcollection._PersistedCollectable,PersistedCollectable,wt.fc._NetFactor,wt.fc._ObjectMappable,wt.fc._Persistable,wt.fc.adminlock._AdministrativelyLockable,AdministrativelyLockable,wt.fc.BusinessInformation,NetFactor,ObjectMappable,Persistable,wt.federation._FederatedLinkHolder,wt.federation._RemotelyLinkable,wt.federation.FederatedLinkHolder,wt.federation.RemotelyLinkable,wt.filter._FilterTemplate,wt.filter.FilterTemplate,wt.folder._CabinetBased,wt.folder._Foldered,wt.folder._FolderEntry,wt.folder._FolderServiceManaged,wt.folder._IteratedFoldered,CabinetBased,Foldered,FolderEntry,wt.folder.FolderServiceManaged,IteratedFoldered,_Genericizable,Genericizable,wt.iba.value._IBAHolder,wt.iba.value.IBAHolder,DisplayIdentification,wt.index._Indexable,Indexable,wt.inf.container._WTContained,WTContained,wt.lifecycle._IteratedLifeCycleManaged,_LifeCycleManaged,IteratedLifeCycleManaged,LifeCycleManaged,wt.locks._Lockable,Lockable,wt.maturity._Promotable,Promotable,wt.meeting.actionitem._IteratedSubjectOfActionItem,wt.meeting.actionitem._SubjectOfActionItem,wt.meeting.actionitem.IteratedSubjectOfActionItem,wt.meeting.actionitem.SubjectOfActionItem,wt.notify._Notifiable,Notifiable,wt.option._ChoiceMappable,wt.option._Expressionable,wt.option._ExpressionAssignable,ChoiceMappable,Expressionable,ExpressionAssignable,wt.ownership._Ownable,wt.ownership.Ownable,wt.recent.RecentlyVisited,_TeamManaged,TeamManaged,wt.type._Typed,wt.type._TypeManaged,wt.type.FlexTyped,wt.type.Typed,wt.type.TypeManaged,wt.ufid._Federatable,wt.ufid.Federatable,_Iterated,wt.vc._Versionable,wt.vc._Versioned,wt.vc.baseline._Baselineable,Baselineable,Iterated,Versionable,Versioned,wt.vc.wip._Workable,Workable,wt.workflow.forum._IteratedSubjectOfForum,wt.workflow.forum._SubjectOfForum,wt.workflow.forum.IteratedSubjectOfForum,SubjectOfForum,wt.workflow.notebook._IteratedSubjectOfNotebook,wt.workflow.notebook._SubjectOfNotebook,wt.workflow.notebook.IteratedSubjectOfNotebook,wt.workflow.notebook.SubjectOfNotebook
@GenAsPersistable(superClass=RevisionControlled.class,interfaces={wt.ufid.Federatable.class,WTContained.class,wt.type.Typed.class,wt.filter.FilterTemplate.class,PersistedCollectable.class,Genericizable.class,com.ptc.windchill.option.model.OptionSetTypeInterface.class,Releasable.class},serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="Description of the Navigation Filter Template."),@GeneratedProperty(name="supportItemChoiceFiltering",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="A flag to indicate whether the filter template supports filtering by supporting item option choices. This value will be used in filter delegates to decide whether choices on supporting items like child WTParts of WTPartUsageLinks will be considered during filtering. When this is set to true, both filterable and supporting object choices will be used for filtering. The default value is false - indicating that filterable\'s choices will be used for filtering."),@GeneratedProperty(name="supportExclusionOptionChoices",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded. The default value is false."),@GeneratedProperty(name="supportEffectivityOnOptionChoices",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="A flag to indicate whether the filter template supports effectivity on option choices. The default value is false."),@GeneratedProperty(name="useExplicitChoiceRuleMembership",type=boolean.class,initialValue="true",supportedAPI=PUBLIC,javaDoc="A flag that indicate whether the choice rule membership used by option set is automatic or user controlled . The default value is false. <br> When value is \"false\" : This mode will automatically find out latest rules such as choice mappings and constraints at runtime for option set.<br> When value is \"true\" : This mode will rely on explicit association rules such as choice mappings and constraints at runtime for option set.<br>"),@GeneratedProperty(name="merged",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="A flag to indicate that the option set was merged. The default value is false",columnProperties=@ColumnProperties(defaultValue="0"))},foreignKeys=@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="master",type=OptionSetMaster.class,cascade=false,constraints=@PropertyConstraints(required=true),accessors=@PropertyAccessors(getAccess=PRIVATE)),myRole=@MyRole(name="iteration",cascade=false,accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PROTECTED))),derivedProperties={@DerivedProperty(name="name",derivedFrom="master>name",supportedAPI=PUBLIC),@DerivedProperty(name="manageLocalRuleChangesIndependently",derivedFrom="master>manageLocalRuleChangesIndependently",supportedAPI=PUBLIC)},iconProperties=@IconProperties(standardIcon="netmarkets/images/optionset.png",openIcon="netmarkets/images/optionset.png"))
public class OptionSet
extends _OptionSet
OptionSet is a collection of options with possible values that can be
used for assigning option rules on part usage links. To be included in
the option filter template,
the attributes must be defined in the option pool a value type as string
or boolean. Attributes included in the option filter template are referred
to as options, while
attribute values are referred to as option choices.
Use the newOptionSet static factory method(s), not the OptionSet
constructor, to construct instances of this class. Instances must be
constructed using the static factory(s), in order to ensure proper initialization
of the instance.
Supported API: true
Extendable: false
- See Also:
-
Field Summary
Fields inherited from class com.ptc.windchill.option.model._OptionSet
DESCRIPTION, EXTERNALIZATION_VERSION_UID, MANAGE_LOCAL_RULE_CHANGES_INDEPENDENTLY, MERGED, NAME, SUPPORT_EFFECTIVITY_ON_OPTION_CHOICES, SUPPORT_EXCLUSION_OPTION_CHOICES, SUPPORT_ITEM_CHOICE_FILTERING, USE_EXPLICIT_CHOICE_RULE_MEMBERSHIPFields inherited from class wt.enterprise.RevisionControlled
VERSION_DISPLAY_IDENTIFIER, VERSION_DISPLAY_IDENTITY, VERSION_DISPLAY_TYPEFields inherited from class wt.fc._WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMPFields inherited from interface wt.access._AdHocControlled
ENTRY_SETFields inherited from interface wt.fc.adminlock._AdministrativelyLockable
ADMINISTRATIVE_LOCKFields inherited from interface wt.change2._Changeable2
HAS_HANGING_CHANGE, HAS_PENDING_CHANGE, HAS_RESULTING_CHANGE, HAS_SUSPECT, HAS_VARIANCEFields inherited from interface wt.content._ContentHolder
CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATIONFields inherited from interface wt.admin._DomainAdministered
DOMAIN_REF, INHERITED_DOMAINFields inherited from interface wt.option._Expressionable
EXPRESSION_DATAFields inherited from interface wt.ufid._Federatable
FEDERATABLE_INFOFields inherited from interface wt.folder._Foldered
CABINET, CABINET_NAME, FOLDERING_INFO, PARENT_FOLDERFields inherited from interface wt.generic._Genericizable
COLLAPSIBLE, GENERIC_TYPE, MAXIMUM_ALLOWED, MINIMUM_REQUIREDFields inherited from interface wt.iba.value._IBAHolder
ATTRIBUTE_CONTAINERFields inherited from interface wt.index._Indexable
INDEXER_SETFields inherited from interface wt.vc._Iterated
BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAMEFields inherited from interface wt.lifecycle._LifeCycleManaged
LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATEFields inherited from interface wt.locks._Lockable
LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAMEFields inherited from interface wt.notify._Notifiable
EVENT_SETFields inherited from interface com.ptc.windchill.option.model._OptionSetTypeInterface
TYPE_INFO_OPTION_SETFields inherited from interface wt.ownership._Ownable
OWNERSHIPFields inherited from interface wt.fc._Persistable
PERSIST_INFOFields inherited from interface wt.access._SecurityLabeled
SECURITY_LABELSFields inherited from interface wt.team._TeamManaged
TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAMEFields inherited from interface wt.type._Typed
TYPE_DEFINITION_REFERENCEFields inherited from interface wt.vc._Versioned
VERSION_IDENTIFIER, VERSION_INFOFields inherited from interface wt.vc.wip._Workable
CHECKOUT_INFOFields inherited from interface wt.inf.container._WTContained
CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCEFields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITYFields inherited from interface wt.folder.CabinetBased
FOLDER_PATH, LOCATIONFields inherited from interface wt.option.ChoiceMappable
LOADER_CACHE_KEYFields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPEFields inherited from interface wt.option.Expressionable
LOADER_CACHE_KEYFields inherited from interface wt.fc.Persistable
IDENTITY, TYPEFields inherited from interface wt.access.SecurityLabeled
SECURITY_LABELS_INTERNAL_VALUEFields inherited from interface wt.vc.Versioned
MASTER_SERIESFields inherited from interface wt.inf.container.WTContained
CONTAINER_ID -
Method Summary
Methods inherited from class com.ptc.windchill.option.model._OptionSet
getAttributeContainer, getClassInfo, getConceptualClassname, getContainer, getContainerName, getContainerReference, getContentVector, getDescription, getExpressionData, getFederatableInfo, getGenericType, getHttpVector, getMaximumAllowed, getMinimumRequired, getOperation, getType, getTypeDefinitionReference, getTypeInfoOptionSet, isHasContents, isMerged, isSupportEffectivityOnOptionChoices, isSupportExclusionOptionChoices, isSupportItemChoiceFiltering, isUseExplicitChoiceRuleMembership, readExternal, readExternal, readVersion, setAttributeContainer, setContainer, setContainerReference, setContentVector, setDescription, setExpressionData, setFederatableInfo, setGenericType, setHasContents, setHttpVector, setMaximumAllowed, setMerged, setMinimumRequired, setOperation, setSupportEffectivityOnOptionChoices, setSupportExclusionOptionChoices, setSupportItemChoiceFiltering, setTypeDefinitionReference, setTypeInfoOptionSet, setUseExplicitChoiceRuleMembership, super_readExternal_OptionSet, super_readVersion_OptionSet, super_writeExternal_OptionSet, writeExternal, writeExternalMethods inherited from class wt.enterprise.RevisionControlled
getBusinessType, getCabinetReference, getCreator, getFolderPath, getIdentity, getIterationDisplayIdentifier, getLocation, getVersionDisplayIdentifier, getVersionDisplayIdentity, getVersionDisplayType, getVersionIdentifier, initialize, setIterationInfoMethods inherited from class wt.enterprise._RevisionControlled
getAdministrativeLock, getBranchIdentifier, getCabinet, getCabinetName, getCheckoutInfo, getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderingInfo, getIndexerSet, getIterationIdentifier, getIterationInfo, getIterationNote, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, getParentFolder, getSecurityLabels, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, getVersionInfo, isHasHangingChange, isHasPendingChange, isHasResultingChange, isHasSuspect, isHasVariance, isInheritedDomain, isLatestIteration, isLifeCycleAtGate, isLifeCycleBasic, isLocked, readVersion, setAdministrativeLock, setCheckoutInfo, setControlBranch, setDomainRef, setEntrySet, setEventSet, setFolderingInfo, setHasHangingChange, setHasPendingChange, setHasResultingChange, setHasSuspect, setHasVariance, setIndexerSet, setInheritedDomain, setLock, setMaster, setMasterReference, setOwnership, setSecurityLabels, setState, setTeamId, setTeamTemplateId, setVersionInfo, super_readExternal_RevisionControlled, super_readVersion_RevisionControlled, super_writeExternal_RevisionControlledMethods inherited from class wt.fc.WTObject
checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, toStringMethods inherited from class wt.fc._WTObject
equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfoMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface wt.vc._Iterated
getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo, setMaster, setMasterReferenceMethods inherited from interface wt.fc._Persistable
getPersistInfo, setPersistInfoMethods inherited from interface wt.fc.Persistable
checkAttributes, getIdentity
-
Method Details
-
getName
Gets the value of the attribute: NAME.
Supported API: true- Specified by:
getNamein interfaceCabinetBased- Overrides:
getNamein class_OptionSet- Returns:
- String
- See Also:
-
setName
Sets the value of the attribute: NAME.
Supported API: true- Overrides:
setNamein class_OptionSet- Parameters:
a_Name-- Throws:
WTPropertyVetoException- See Also:
-