Package com.sas.metadata.remote

Interface PrimaryType

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root
All Known Subinterfaces:
AbstractJob, AbstractPrompt, AbstractTransformation, AccessControl, AccessControlEntry, AccessControlTemplate, Action, Aggregation, AnalyticContext, ApplicationAction, ArchiveEntry, ArchiveFile, AuthenticationDomain, CalculatedMeasure, CalculatedMember, Classifier, ClassifierMap, Column, ColumnHierarchy, ColumnRange, COMConnection, Condition, ConditionActionSet, ConfiguredComponent, Connection, ContentLocation, ContentType, Cube, DatabaseCatalog, DatabaseSchema, DataSourceName, DataTable, DeployedComponent, DeployedDataPackage, Device, DeviceType, Dimension, Directory, Document, Email, Event, ExternalTable, FavoritesContainer, Feature, FeatureMap, File, GlobalFormula, Group, Hierarchy, HierarchyLevel, Identity, IdentityGroup, Index, ITChannel, ITContentSubscriber, ITEventSubscriber, ITSubscriber, JFJob, Job, Join, JoinTable, Level, LogicalColumn, LogicalServer, Login, Machine, Measure, Memory, MiningResult, NamedService, NamedSet, OLAPProperty, OLAPSchema, OpenClientConnection, Permission, Person, PhysicalTable, Prompt, PromptGroup, Prototype, PSColumnLayoutComponent, PSLayoutComponent, PSPortalPage, PSPortalProfile, PSPortlet, QueryTable, RelationalSchema, RelationalTable, Report, SASCatalog, SASCatalogEntry, SASClientConnection, SASFileRef, SASLibrary, SASLicense, Search, SecuredLibrary, SecuredTable, SecurityRuleScheme, Select, ServerComponent, ServerContext, ServiceComponent, SharedDimension, SoftwareComponent, Stream, SXLEMap, SyncStep, TableCollection, TCPIPConnection, Text, TextStore, Transformation, TransformationActivity, TransformationStep, Tree, TSNameObject, TSNamespace, TypeDefinition, WorkTable
public interface PrimaryType extends Root
The PrimaryType subtypes are the starting point for modeling a logical metadata definition. When the logical metadata definition models an object that is managed by the SAS type dictionary, the PublicType= attribute must be set to indicate the type of object.

Logical metadata definitions that are managed by the dictionary are copied, deleted, moved, and secured as a unit, and are usually contained in a folder. Some PrimaryType subtypes may be embedded in a logical metadata definition; these are considered components. A component may be secured apart from the containing object. For example, a column may have security different from the containing table. A component is copied, deleted, and secured with its containing object, but can also be copied, deleted, and secured apart from the containing object.

All other SAS Metadata Model metadata types are SecondaryType subtypes. SecondaryType subtypes may not reside in a folder and are always contained, directly or indirectly, by a PrimaryType subtype. SecondaryType objects may not be shared by logical metadata definitions.

Attributes of PrimaryType are:

Associations of PrimaryType are:

Usage

To create an instance of this PrimaryType, use the factory create methods.
Example: create a PrimaryType with name "PrimaryType_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();
 PrimaryType myObject = (PrimaryType) factory.createComplexMetadataObject(objectStore, "PrimaryType_Object", MetadataObjects.PRIMARYTYPE, "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 updateMetadataAll method.
  • If an object needs to be deleted, the delete method 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 Details

    • ATTRIBUTE_PUBLICTYPE_NAME

      static final String ATTRIBUTE_PUBLICTYPE_NAME
      Constant used for the name of the PublicType attribute.

      PublicType: Specifies the name of a type definition in the SAS type dictionary. The SAS type dictionary includes definitions for the common and shared object types used by all SAS intelligence platform applications. The type definitions have all of the information necessary to display, import, export, and delete these common and shared objects in a SAS intelligence platform application. This information includes a template that identifies all of the metadata types and associations that describe the object in a SAS Metadata Repository.

      See Also:

    • ATTRIBUTE_ISHIDDEN_NAME

      static final String ATTRIBUTE_ISHIDDEN_NAME
      Constant used for the name of the IsHidden attribute.

      IsHidden: When set to "True", this object should not be shown by default in the folder view or search interface.

      See Also:

    • ASSOCIATION_FAVORITESCONTAINERS_NAME

      static final String ASSOCIATION_FAVORITESCONTAINERS_NAME
      Constant used for the name of the FavoritesContainers association.

      FavoritesContainers: The container for which this is a favorite.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      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:
      FavoritesContainers
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPublicType

      String getPublicType() throws RemoteException
      Gets the String value of PublicType
      Returns:
      The PublicType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPublicTypeState

      int getPublicTypeState() throws RemoteException
      Gets the Metadata State of PublicType
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getPublicTypeMaxLength

      int getPublicTypeMaxLength() throws RemoteException
      Gets the maximum length of PublicType
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsHidden

      int getIsHidden() throws RemoteException
      Gets the int value of IsHidden
      Returns:
      The IsHidden
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsHiddenState

      int getIsHiddenState() throws RemoteException
      Gets the Metadata State of IsHidden
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getFavoritesContainers

      AssociationList getFavoritesContainers() throws RemoteException, MdException
      Gets the AssociationList of FavoritesContainers
      Returns:
      Returns the AssociationList of FavoritesContainers which can be of type:
      FavoritesContainer
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getFavoritesContainers

      AssociationList getFavoritesContainers(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of FavoritesContainers
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of FavoritesContainers which can be of type:
      FavoritesContainer
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setPublicType

      void setPublicType(String inPublicType) throws RemoteException
      Sets the PublicType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inPublicType - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setPublicType

      void setPublicType(String inPublicType, int state) throws RemoteException
      Sets the PublicType Metadata State.
      Parameters:
      inPublicType - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPublicTypeState

      void setPublicTypeState(int state) throws RemoteException
      Sets the Metadata State of PublicType.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsHidden

      void setIsHidden(int inIsHidden) throws RemoteException
      Sets the IsHidden value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsHidden - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsHidden

      void setIsHidden(int inIsHidden, int state) throws RemoteException
      Sets the IsHidden Metadata State.
      Parameters:
      inIsHidden - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsHidden

      void setIsHidden(String inIsHidden) throws RemoteException
      Sets the IsHidden value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsHidden - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsHidden

      void setIsHidden(String inIsHidden, int state) throws RemoteException
      Sets the IsHidden value and Metadata State.
      Parameters:
      inIsHidden - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsHiddenState

      void setIsHiddenState(int state) throws RemoteException
      Sets the Metadata State of IsHidden.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setFavoritesContainers

      void setFavoritesContainers(AssociationList list) throws RemoteException
      Sets the FavoritesContainers list to be list. Objects of which can be of type:
      FavoritesContainer
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setFavoritesContainers

      void setFavoritesContainers(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.