Package com.sas.metadata.remote

Interface DeviceType

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface DeviceType extends PrimaryType
Defines a prototype for a specific supported device.

Attributes of DeviceType are:

Associations of DeviceType are:

Usage

To create an instance of this DeviceType, use the factory create methods.
Example: create a DeviceType with name "DeviceType_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();
 DeviceType myObject = (DeviceType) factory.createComplexMetadataObject(objectStore, "DeviceType_Object", MetadataObjects.DEVICETYPE, "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_WIDTH_NAME

      static final String ATTRIBUTE_WIDTH_NAME
      Constant used for the name of the Width attribute.

      Width: Width supported by this device.

      See Also:

    • ATTRIBUTE_HEIGHT_NAME

      static final String ATTRIBUTE_HEIGHT_NAME
      Constant used for the name of the Height attribute.

      Height: Height supported by this device.

      See Also:

    • ATTRIBUTE_ISCOLOR_NAME

      static final String ATTRIBUTE_ISCOLOR_NAME
      Constant used for the name of the IsColor attribute.

      IsColor: A boolean value that indicates whether this device supports color.

      See Also:

    • ATTRIBUTE_BITDEPTH_NAME

      static final String ATTRIBUTE_BITDEPTH_NAME
      Constant used for the name of the BitDepth attribute.

      BitDepth: Bit depth supported by this device.

      See Also:

    • ASSOCIATION_DEPLOYEDDEVICES_NAME

      static final String ASSOCIATION_DEPLOYEDDEVICES_NAME
      Constant used for the name of the DeployedDevices association.

      DeployedDevices: Devices of this device type.  

      See Also:

    • ASSOCIATION_CONTENTTYPES_NAME

      static final String ASSOCIATION_CONTENTTYPES_NAME
      Constant used for the name of the ContentTypes association.

      ContentTypes: The content types that can be displayed by this device. 

      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 PrimaryType
      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:
      DeployedDevices
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getWidth

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

    • getWidthState

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

    • getHeight

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

    • getHeightState

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

    • getIsColor

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

    • getIsColorState

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

    • getBitDepth

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

    • getBitDepthState

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

    • getDeployedDevices

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

    • getContentTypes

      AssociationList getContentTypes() throws RemoteException, MdException
      Gets the Association list of ContentTypes
      Returns:
      The AssociationList of ContentTypes which can be of type:
      ContentType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getDeployedDevices

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

    • getContentTypes

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

    • setWidth

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

    • setWidth

      void setWidth(int inWidth, int state) throws RemoteException
      Sets the Width Metadata State.
      Parameters:
      inWidth - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setWidth

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

    • setWidth

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

    • setWidthState

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

    • setHeight

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

    • setHeight

      void setHeight(int inHeight, int state) throws RemoteException
      Sets the Height Metadata State.
      Parameters:
      inHeight - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setHeight

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

    • setHeight

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

    • setHeightState

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

    • setIsColor

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

    • setIsColor

      void setIsColor(int inIsColor, int state) throws RemoteException
      Sets the IsColor Metadata State.
      Parameters:
      inIsColor - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsColor

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

    • setIsColor

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

    • setIsColorState

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

    • setBitDepth

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

    • setBitDepth

      void setBitDepth(int inBitDepth, int state) throws RemoteException
      Sets the BitDepth Metadata State.
      Parameters:
      inBitDepth - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setBitDepth

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

    • setBitDepth

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

    • setBitDepthState

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

    • setDeployedDevices

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

    • setDeployedDevices

      void setDeployedDevices(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.

    • setContentTypes

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

    • setContentTypes

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