Package com.sas.metadata.remote
Interface SecurityTypeContainmentRule
- All Superinterfaces:
CMetadata,MdObjectBase,MdObjectBaseUtil,MdObjectBaseXML,Remote,Root,SecondaryType,SecurityRule
A SecurityTypeContainmentRule tells the authorization facility how to find parent objects for a particular metadata type. There may be more than one rule for any class.
Example: create a SecurityTypeContainmentRule with name "SecurityTypeContainmentRule_Object", in repository "AAAAAAAA".
Attributes of SecurityTypeContainmentRule are:
Associations of SecurityTypeContainmentRule are:
Usage
To create an instance of this SecurityTypeContainmentRule, use thefactory
create methods. Example: create a SecurityTypeContainmentRule with name "SecurityTypeContainmentRule_Object", in repository "AAAAAAAA".
// create a store to contain your objects for this change. If you do not have an existing object // or store to use. You may obtain the store from another object by using Object.getObjectStore(). MdFactory factory; //where "factory" is a valid MdFactory instance MdObjectStore objectStore = factory.createObjectStore(); SecurityTypeContainmentRule myObject = (SecurityTypeContainmentRule) factory.createComplexMetadataObject(objectStore, "SecurityTypeContainmentRule_Object", MetadataObjects.SECURITYTYPECONTAINMENTRULE, "AAAAAAAA"); myObject.updateMetadataAll(); // Write object to server objectStore.dispose(); // dispose of the object store if it is no longer needed
Behavior
- Attributes and associations for this object can be retrieved by using the methods in
MdOMIUtil. - When changes are made to the object, either by setting an attribute or adding objects to a particular association,
they can be persisted to the metadata server with the
updateMetadataAllmethod. - If an object needs to be deleted, the
deletemethod can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.
Dependencies
This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.- Since:
- 9.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringConstant used for the name of the TypeName attribute.Fields inherited from interface com.sas.metadata.remote.MdObjectBase
ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAMEFields inherited from interface com.sas.metadata.remote.Root
ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAMEFields inherited from interface com.sas.metadata.remote.SecurityRule
ASSOCIATION_SECRULESCHEME_NAME, ATTRIBUTE_RULE_NAME, ATTRIBUTE_TYPE_NAME -
Method Summary
Modifier and TypeMethodDescriptionStringGets theStringvalue ofTypeNameintGets the maximum length ofTypeNameintGets the Metadata State ofTypeNamevoid(S) Adds the Associated objects to the predObjects which are:void(S) This initializes the Required Objects(Roles) which are:voidsetTypeName(String inTypeName) Sets theTypeNamevalue and sets the state to MetadataState.LOCAL.voidsetTypeName(String inTypeName, int state) Sets theTypeNameMetadata State.voidsetTypeNameState(int state) Sets the Metadata State ofTypeName.Methods inherited from interface com.sas.metadata.remote.MdObjectBase
addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setStateMethods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil
addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getAuthorizationUtil, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIdsMethods inherited from interface com.sas.metadata.remote.MdObjectBaseXML
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAllMethods inherited from interface com.sas.metadata.remote.Root
getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariablesMethods inherited from interface com.sas.metadata.remote.SecurityRule
getRule, getRuleMaxLength, getRuleState, getSecRuleScheme, getSecRuleSchemes, getSecRuleSchemes, getType, getTypeMaxLength, getTypeState, setRule, setRule, setRuleState, setSecRuleScheme, setSecRuleSchemes, setSecRuleSchemes, setType, setType, setTypeState
-
Field Details
-
ATTRIBUTE_TYPENAME_NAME
static final String ATTRIBUTE_TYPENAME_NAMEConstant used for the name of the TypeName attribute.TypeName: Name of metadata type for which this rule applies.
- See Also:
-
-
Method Details
-
initializeRequiredObjects
void initializeRequiredObjects() throws RemoteException(S) This initializes the Required Objects(Roles) which are:- Specified by:
initializeRequiredObjectsin interfaceMdObjectBaseUtil- Specified by:
initializeRequiredObjectsin interfaceRoot- Specified by:
initializeRequiredObjectsin interfaceSecondaryType- Specified by:
initializeRequiredObjectsin interfaceSecurityRule- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
initializePredObjects
void initializePredObjects() throws RemoteException(S) Adds the Associated objects to the predObjects which are:- Specified by:
initializePredObjectsin interfaceMdObjectBase- Specified by:
initializePredObjectsin interfaceRoot- Specified by:
initializePredObjectsin interfaceSecondaryType- Specified by:
initializePredObjectsin interfaceSecurityRule- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getTypeName
String getTypeName() throws RemoteExceptionGets theStringvalue ofTypeName- Returns:
- The
TypeName - Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getTypeNameState
int getTypeNameState() throws RemoteExceptionGets the Metadata State ofTypeName- Returns:
- The State.
- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
getTypeNameMaxLength
int getTypeNameMaxLength() throws RemoteExceptionGets the maximum length ofTypeName- Returns:
- The max size
- Throws:
RemoteException- If error connecting/communicating to/with remote object.
-
setTypeName
void setTypeName(String inTypeName) throws RemoteException Sets theTypeNamevalue and sets the state to MetadataState.LOCAL.- Parameters:
inTypeName- String- Throws:
RemoteException- If error communicating with remote object.
-
setTypeName
void setTypeName(String inTypeName, int state) throws RemoteException Sets theTypeNameMetadata State.- Parameters:
inTypeName- Stringstate- int- Throws:
RemoteException- If error communicating with remote object.
-
setTypeNameState
void setTypeNameState(int state) throws RemoteException Sets the Metadata State ofTypeName.- Parameters:
state- int- Throws:
RemoteException- If error communicating with remote object.
-