Package com.sas.metadata.remote

Interface LocalizedResource

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface LocalizedResource extends SecondaryType
Contains the localized values for a particular locale as defined by the LocalId attribute. Locale information contained in the LocalizedResource is used when displaying information contained in the associated LocalizedObject. The Value attribute contains the localized version of the value for the property specified by the Name attribute.

Attributes of LocalizedResource are:

Associations of LocalizedResource are:

Usage

To create an instance of this LocalizedResource, use the factory create methods.
Example: create a LocalizedResource with name "LocalizedResource_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();
 LocalizedResource myObject = (LocalizedResource) factory.createComplexMetadataObject(objectStore, "LocalizedResource_Object", MetadataObjects.LOCALIZEDRESOURCE, "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_VALUE_NAME

      static final String ATTRIBUTE_VALUE_NAME
      Constant used for the name of the Value attribute.

      Value: This attribute contains either the localized version of the property specified by the Name attribute or a URL used to find the localized value.

      See Also:

    • ATTRIBUTE_ISURL_NAME

      static final String ATTRIBUTE_ISURL_NAME
      Constant used for the name of the IsURL attribute.

      IsURL: This indicates whether the Value attribute contains a localized string or a URL.

      See Also:

    • ATTRIBUTE_LOCALEID_NAME

      static final String ATTRIBUTE_LOCALEID_NAME
      Constant used for the name of the LocaleID attribute.

      LocaleID: This is either either 'la' or 'la_co' where la is a ISO 639 language code (http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt) and co is a ISO 3166 country code (http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html)

      See Also:

    • ASSOCIATION_LOCALIZEDOBJECT_NAME

      static final String ASSOCIATION_LOCALIZEDOBJECT_NAME
      Constant used for the name of the LocalizedObject association.

      LocalizedObject: LocalizedObject is the object for which the localized values contained by or referenced by this LocalizedResource apply. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getValue

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

    • getValueState

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

    • getValueMaxLength

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

    • getIsURL

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

    • getIsURLState

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

    • getLocaleID

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

    • getLocaleIDState

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

    • getLocaleIDMaxLength

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

    • getLocalizedObjects

      AssociationList getLocalizedObjects() throws RemoteException, MdException
      Gets the Association list of LocalizedObjects
      Returns:
      The AssociationList of LocalizedObjects which can be of type:
      LocalizedType
      PropertyGroup
      PropertyType
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLocalizedObject

      LocalizedType getLocalizedObject() throws RemoteException, MdException
      Gets the LocalizedType for LocalizedObject
      Returns:
      The LocalizedType ( null if not set ) of LocalizedObject which can be of type:
      LocalizedType
      PropertyGroup
      PropertyType
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLocalizedObjects

      AssociationList getLocalizedObjects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of LocalizedObjects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the LocalizedObjects which can be of type:
      LocalizedType
      PropertyGroup
      PropertyType
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setValue

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

    • setValue

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

    • setValueState

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

    • setIsURL

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

    • setIsURL

      void setIsURL(int inIsURL, int state) throws RemoteException
      Sets the IsURL Metadata State.
      Parameters:
      inIsURL - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsURL

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

    • setIsURL

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

    • setIsURLState

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

    • setLocaleID

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

    • setLocaleID

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

    • setLocaleIDState

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

    • setLocalizedObjects

      void setLocalizedObjects(AssociationList list) throws RemoteException
      Sets the LocalizedObjects list to be list. Objects of which can be of type:
      LocalizedType
      PropertyGroup
      PropertyType
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocalizedObjects

      void setLocalizedObjects(AssociationList list, int state) throws RemoteException
      Sets the LocalizedObjects list to be list. Objects of which can be of type:
      LocalizedType
      PropertyGroup
      PropertyType
      AbstractProperty
      Property
      PrototypeProperty
      AttributeProperty
      AssociationProperty
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocalizedObject

      void setLocalizedObject(LocalizedType inObject) throws RemoteException
      Sets the LocalizedObjects list 0th element to be inObject.
      Parameters:
      inObject - LocalizedType
      Throws:
      RemoteException - If error communicating with remote object.