*** This interface is subject to change. ***

com.sas.iquery.metadata.business
Interface ModelItemWithIdentity

All Superinterfaces:

Base, java.util.EventListener, ModelItem, NamedObjectInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, UsabilityInterface

All Known Subinterfaces:

BusinessGroup, BusinessItem, BusinessModelObject, BusinessRule, CompoundFilter, DataItem, DataItemReference, DrillThroughToDetail, FilterCascadeRule, FilterItem, Governing, Prompt

@SASScope(value="ALL")
@SubjectToChange
public interface ModelItemWithIdentity
extends ModelItem, NamedObjectInterface

Field Summary

static java.lang.String	EVENT_DESCRIPTION_CHANGED Description associated with the object has changed.
static java.lang.String	EVENT_HIDDEN_CHANGED The "hidden" attribute associated with the object has changed.
static java.lang.String	EVENT_ID_CHANGED ID associated with the object has changed.
static java.lang.String	EVENT_LABEL_CHANGED Label associated with the object has changed.

Fields inherited from interface com.sas.iquery.metadata.business.ModelItem

EVENT_OBJECT_PROPERTY_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.Base

EVENT_OBJECT_DEFINITION_CHANGED

Method Summary

abstract java.lang.String	getID() Returns the unique inter-model ID for this object.
abstract java.lang.String	getIdentityString() Returns a somewhat visually pleasing string giving the identity of this object
abstract java.lang.String	getIntraModelID() Returns the intra-model ID for this object.
abstract boolean	isHidden() Returns true if this object should not be shown to the user.
abstract boolean	isUnresolved() Returns whether this object is unresolved or not.
abstract void	setDescription(java.lang.String description) Sets the description for this object.
abstract void	setIntraModelID(java.lang.String ID) Sets the intended-to-be unique intra-model ID for this object.
abstract void	setIsHidden(boolean hidden) Sets the hidden attribute value for this object.
abstract void	setLabel(java.lang.String label) Sets the label for this object.

Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee

addListener, getListeners, removeListener

Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

getReasonsUnusable, isUsableInQuery

Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface

getDescription, getLabel

Field Detail

*** This field is subject to change. ***

EVENT_LABEL_CHANGED

@SASScope(value="ALL")
@SubjectToChange
static final java.lang.String EVENT_LABEL_CHANGED

Label associated with the object has changed.

See Also:

Constant Field Values

*** This field is subject to change. ***

EVENT_DESCRIPTION_CHANGED

@SASScope(value="ALL")
@SubjectToChange
static final java.lang.String EVENT_DESCRIPTION_CHANGED

Description associated with the object has changed.

See Also:

Constant Field Values

*** This field is subject to change. ***

EVENT_ID_CHANGED

@SASScope(value="ALL")
@SubjectToChange
static final java.lang.String EVENT_ID_CHANGED

ID associated with the object has changed.

See Also:

Constant Field Values

*** This field is subject to change. ***

EVENT_HIDDEN_CHANGED

@SASScope(value="ALL")
@SubjectToChange
static final java.lang.String EVENT_HIDDEN_CHANGED

The "hidden" attribute associated with the object has changed.

See Also:

Constant Field Values

Method Detail

*** This method is subject to change. ***

setLabel

@SASScope(value="ALL")
@SubjectToChange
void setLabel(java.lang.String label)
              throws MetadataException

Sets the label for this object.

Property change events signalled:

• EVENT_LABEL_CHANGED

Parameters:

label - The string to use as the label. Specifying null is allowed.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

*** This method is subject to change. ***

setDescription

@SASScope(value="ALL")
@SubjectToChange
void setDescription(java.lang.String description)
                    throws MetadataException

Sets the description for this object. A description is intended to provide a longer worded phrase than the label itself.

Property change events signalled:

• EVENT_DESCRIPTION_CHANGED

Parameters:

description - The string to use as the description. Specifying null is allowed.

Throws:

MetadataNotChangeableException - if this BusinessModelObject is read-only

MetadataException

*** This method is subject to change. ***

getIntraModelID

@SASScope(value="ALL")
@SubjectToChange
java.lang.String getIntraModelID()

Returns the intra-model ID for this object. See the BusinessModel class for information on IDs.

Returns:

the ID of this object that should be unique for objects contained within this object's "owning" business model or null if not set

*** This method is subject to change. ***

setIntraModelID

@SASScope(value="ALL")
@SubjectToChange
void setIntraModelID(java.lang.String ID)
                     throws InvalidIDException

Sets the intended-to-be unique intra-model ID for this object. Checking for uniqueness is not done during this method but rather during the isIDOK() method. That method is called at persistence time to ensure uniqueness of intra-model IDs within a model.

Property change events signalled:

• EVENT_ID_CHANGED

Parameters:

ID - a valid intra-model ID to be set on this object

Throws:

InvalidIDException - if the id is invalid. An invalid ID is one that contains an invalid character.

MetadataNotChangeableException - if this object is read-only

*** This method is subject to change. ***

getID

@SASScope(value="ALL")
@SubjectToChange
java.lang.String getID()
                       throws InvalidIDException

Returns the unique inter-model ID for this object. This ID is made up of this object's business model's ID concatenated with the inter-model ID delimiter string (BusinessModel.INTERMODEL_ID_DELIMITER) concatenated with this object's intra-model ID.

  Example:

  "PersonnelData.Salary"  would be the inter-model ID if the business model's ID
  is "PersonnelData" and the object's intra-model ID is "Salary".

Returns:

the unique inter-model ID of this object

Throws:

InvalidIDException - either this object's ID is not set or the business model that created this object has an ID that is not set.

*** This method is subject to change. ***

isHidden

@SASScope(value="ALL")
@SubjectToChange
boolean isHidden()

Returns true if this object should not be shown to the user. It is typically up to the creator of this object to decide if it should be hidden or not by using setIsHidden(). The hidden attribute for newly created objects is set to false.

Returns:

a boolean value indicating if this object should not be shown to the user

*** This method is subject to change. ***

setIsHidden

@SASScope(value="ALL")
@SubjectToChange
void setIsHidden(boolean hidden)

Sets the hidden attribute value for this object. If true this object should not be shown to the user. The hidden attribute for newly created objects is set to false.

Parameters:

hidden - boolean value indicating if this object should not be shown to the user

Throws:

MetadataNotChangeableException - if this object is read-only

*** This method is subject to change. ***

isUnresolved

@SASScope(value="ALL")
@SubjectToChange
boolean isUnresolved()

Returns whether this object is unresolved or not. An unresolved business model resource is a reference to a resource external to a business model that no longer exists or could not be found.

Returns:

a boolean value indicating whether this object is unresolved

*** This method is subject to change. ***

getIdentityString

@SASScope(value="ALL")
@SubjectToChange
java.lang.String getIdentityString()

Returns a somewhat visually pleasing string giving the identity of this object

Returns:

identity string

*** This interface is subject to change. ***