com.ibm.etools.xsd
Interface XSDAttributeUse

All Superinterfaces:
com.ibm.etools.emf.notify.Notifier, com.ibm.etools.emf.ref.RefBaseObject, com.ibm.etools.emf.ref.RefObject, com.ibm.etools.emf.resource.ResourceSetReference, XSDAttributeGroupContent, XSDComponent, XSDConcreteComponent
All Known Implementing Classes:
XSDAttributeUseImpl

public interface XSDAttributeUse
extends XSDAttributeGroupContent, XSDComponent

A representation of the model object 'Attribute Use'.

The following features are supported:

See Also:
XSDPackage.getXSDAttributeUse()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface com.ibm.etools.emf.notify.Notifier
ADD, ADD_MANY, CREATE, MOVE, NO_INDEX, REMOVE, REMOVE_MANY, REMOVING_ADAPTER, SET, TOUCH, UNSET
 
Method Summary
 com.ibm.etools.emf.ecore.EClass eClassXSDAttributeUse()
          Returns the meta class of XSDAttributeUse.
 XSDAttributeDeclaration getAttributeDeclaration()
          Returns the value of the 'Attribute Declaration' reference.
 java.lang.Integer getConstraint()
          Returns the Integer value of the 'Constraint' attribute.
 XSDAttributeDeclaration getContent()
          Returns the value of the 'Content' reference.
 java.lang.String getLexicalValue()
          Returns the value of the 'Lexical Value' attribute.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralConstraint()
          Returns the value of the 'Constraint' attribute.
 com.ibm.etools.emf.ecore.EEnumLiteral getLiteralUse()
          Returns the value of the 'Use' attribute.
 java.lang.Boolean getRequired()
          Returns the value of the 'Required' attribute.
 java.lang.String getStringConstraint()
          Returns the String value of the 'Constraint' attribute.
 java.lang.String getStringUse()
          Returns the String value of the 'Use' attribute.
 java.lang.Integer getUse()
          Returns the Integer value of the 'Use' attribute.
 java.lang.Object getValue()
          Returns the value of the 'Value' attribute.
 int getValueConstraint()
          Returns the primitive value of the 'Constraint' attribute.
 int getValueUse()
          Returns the primitive value of the 'Use' attribute.
 boolean isRequired()
          Returns whether the object is 'Required'.
 boolean isSetAttributeDeclaration()
          Returns whether the value of the 'Attribute Declaration' reference is set.
 boolean isSetConstraint()
          Returns whether the value of the 'Constraint' attribute is set.
 boolean isSetContent()
          Returns whether the value of the 'Content' reference is set.
 boolean isSetLexicalValue()
          Returns whether the value of the 'Lexical Value' attribute is set.
 boolean isSetRequired()
          Returns whether the value of the 'Required' attribute is set.
 boolean isSetUse()
          Returns whether the value of the 'Use' attribute is set.
 boolean isSetValue()
          Returns whether the value of the 'Value' attribute is set.
 void setAttributeDeclaration(XSDAttributeDeclaration value)
          Sets the value of the 'Attribute Declaration' reference.
 void setConstraint(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(int value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(java.lang.Integer value)
          Sets the value of the 'Constraint' attribute.
 void setConstraint(java.lang.String value)
          Sets the value of the 'Constraint' attribute.
 void setContent(XSDAttributeDeclaration value)
          Sets the value of the 'Content' reference.
 void setLexicalValue(java.lang.String value)
          Sets the value of the 'Lexical Value' attribute.
 void setRequired(boolean value)
          Sets the value of the 'Required' attribute.
 void setRequired(java.lang.Boolean value)
          Sets the value of the 'Required' attribute.
 void setUse(com.ibm.etools.emf.ecore.EEnumLiteral value)
          Sets the value of the 'Use' attribute.
 void setUse(int value)
          Sets the value of the 'Use' attribute.
 void setUse(java.lang.Integer value)
          Sets the value of the 'Use' attribute.
 void setUse(java.lang.String value)
          Sets the value of the 'Use' attribute.
 void setValue(java.lang.Object value)
          Sets the value of the 'Value' attribute.
 void unsetAttributeDeclaration()
          Unsets the value of the 'Attribute Declaration' reference.
 void unsetConstraint()
          Unsets the value of the 'Constraint' attribute.
 void unsetContent()
          Unsets the value of the 'Content' reference.
 void unsetLexicalValue()
          Unsets the value of the 'Lexical Value' attribute.
 void unsetRequired()
          Unsets the value of the 'Required' attribute.
 void unsetUse()
          Unsets the value of the 'Use' attribute.
 void unsetValue()
          Unsets the value of the 'Value' attribute.
 
Methods inherited from interface com.ibm.etools.xsd.XSDAttributeGroupContent
eClassXSDAttributeGroupContent
 
Methods inherited from interface com.ibm.etools.xsd.XSDConcreteComponent
clearDiagnostics, cloneConcreteComponent, contains, eClassXSDConcreteComponent, elementAttributesChanged, elementChanged, elementContentsChanged, ePackageXSD, getComponentsWithApplicationInformation, getComponentsWithUserInformation, getContainer, getDiagnostics, getElement, getOwner, getRootContainer, getRootOwner, getSchema, getURIReferencePath, isSetElement, isSetOwner, isSetRootOwner, isSetSchema, resolveAttributeDeclaration, resolveAttributeDeclaration, resolveAttributeDeclarationURI, resolveAttributeGroupDefinition, resolveAttributeGroupDefinition, resolveAttributeGroupDefinitionURI, resolveComplexTypeDefinition, resolveComplexTypeDefinition, resolveComplexTypeDefinitionURI, resolveElementDeclaration, resolveElementDeclaration, resolveElementDeclarationURI, resolveIdentityConstraintDefinition, resolveIdentityConstraintDefinition, resolveIdentityConstraintDefinitionURI, resolveModelGroupDefinition, resolveModelGroupDefinition, resolveModelGroupDefinitionURI, resolveNotationDeclaration, resolveNotationDeclaration, resolveNotationDeclarationURI, resolveSimpleTypeDefinition, resolveSimpleTypeDefinition, resolveSimpleTypeDefinitionURI, resolveTypeDefinition, resolveTypeDefinition, resolveTypeDefinitionURI, setElement, setOwner, setRootOwner, setSchema, unsetElement, unsetOwner, unsetRootOwner, unsetSchema, updateElement, updateElement, validate
 
Methods inherited from interface com.ibm.etools.emf.ref.RefObject
initInstance, refAddValue, refAddValueAt, refAddValueBefore, refCurrentValues, refDelegateOwner, refGetDefaultValues, refIsSet, refModifyValue, refModifyValueAt, refRemoveValue, refRemoveValueAt, refSetDelegateOwner, refSetValue, refUnsetValue, refValue
 
Methods inherited from interface com.ibm.etools.emf.ref.RefBaseObject
metaObject, refAttributes, refContainer, refContainerExtent, refContainerSF, refContainments, refContainments, refContains, refContains, refContainsExtent, refContainsNested, refDelete, refExtent, refID, refImmediatePackage, refIsContainer, refItself, refMetaObject, refMofId, refName, refOutermostPackage, refPackage, refReferences, refRemoveContent, refResource, refSetExtent, refSetID, refSetID, refSetIDContains, refSetMetaObject, refSetUUID, refSetUUID, refSetUUID
 
Methods inherited from interface com.ibm.etools.emf.notify.Notifier
addAdapter, getAdapter, getAdapters, getExistingAdapter, isDelivery, isDeliveryAll, notify, notify, removeAdapter, removeAllAdapters, setDelivery, setDeliveryAll
 
Methods inherited from interface com.ibm.etools.emf.resource.ResourceSetReference
getResourceSet
 
Methods inherited from interface com.ibm.etools.xsd.XSDComponent
eClassXSDComponent
 

Field Detail

copyright

public static final java.lang.String copyright
Method Detail

eClassXSDAttributeUse

public com.ibm.etools.emf.ecore.EClass eClassXSDAttributeUse()
Returns the meta class of XSDAttributeUse.
Returns:
the meta class.
See Also:
XSDPackage.getXSDAttributeUse(), XSDConcreteComponent.ePackageXSD()

getRequired

public java.lang.Boolean getRequired()
Returns the value of the 'Required' attribute.

This represents the required infoset property.

Returns:
the value of the 'Required' attribute.
See Also:
isRequired(), isSetRequired(), unsetRequired(), setRequired(Boolean), XSDPackage.getXSDAttributeUse_Required()

isRequired

public boolean isRequired()
Returns whether the object is 'Required'.
Returns:
whether the object is 'Required'.
See Also:
getRequired(), isSetRequired(), unsetRequired(), setRequired(boolean)

setRequired

public void setRequired(java.lang.Boolean value)
Sets the value of the 'Required' attribute.
Parameters:
value - the new value of the 'Required' attribute.
See Also:
setRequired(boolean), isSetRequired(), unsetRequired(), getRequired()

setRequired

public void setRequired(boolean value)
Sets the value of the 'Required' attribute.
Parameters:
value - the new value of the 'Required' attribute.
See Also:
setRequired(Boolean), isSetRequired(), unsetRequired(), isRequired()

unsetRequired

public void unsetRequired()
Unsets the value of the 'Required' attribute.
See Also:
isSetRequired(), getRequired(), setRequired(Boolean)

isSetRequired

public boolean isSetRequired()
Returns whether the value of the 'Required' attribute is set.
Returns:
whether the value of the 'Required' attribute is set.
See Also:
unsetRequired(), getRequired(), setRequired(Boolean)

getValue

public java.lang.Object getValue()
Returns the value of the 'Value' attribute.

This represents the value of the value constraint infoset property. It is computed from the lexical value and should typically not be set directly.

Returns:
the value of the 'Value' attribute.
See Also:
isSetValue(), unsetValue(), setValue(java.lang.Object), XSDPackage.getXSDAttributeUse_Value()

setValue

public void setValue(java.lang.Object value)
Sets the value of the 'Value' attribute.
Parameters:
value - the new value of the 'Value' attribute.
See Also:
isSetValue(), unsetValue(), getValue()

unsetValue

public void unsetValue()
Unsets the value of the 'Value' attribute.
See Also:
isSetValue(), getValue(), setValue(java.lang.Object)

isSetValue

public boolean isSetValue()
Returns whether the value of the 'Value' attribute is set.
Returns:
whether the value of the 'Value' attribute is set.
See Also:
unsetValue(), getValue(), setValue(java.lang.Object)

getLiteralConstraint

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralConstraint()
Returns the value of the 'Constraint' attribute. The literals are from the enumeration XSDConstraint.

This represents the constraint of the value constraint infoset property.

Returns:
the value of the 'Constraint' attribute.
See Also:
getValueConstraint(), getConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(EEnumLiteral), XSDPackage.getXSDAttributeUse_Constraint()

getValueConstraint

public int getValueConstraint()
Returns the primitive value of the 'Constraint' attribute.
Returns:
the primitive value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getValueConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(int)

getStringConstraint

public java.lang.String getStringConstraint()
Returns the String value of the 'Constraint' attribute.
Returns:
the String value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getConstraint(), getValueConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(String)

getConstraint

public java.lang.Integer getConstraint()
Returns the Integer value of the 'Constraint' attribute.
Returns:
the Integer value of the 'Constraint' attribute.
See Also:
getLiteralConstraint(), getValueConstraint(), getStringConstraint(), XSDConstraint, isSetConstraint(), unsetConstraint(), setConstraint(Integer)

setConstraint

public void setConstraint(com.ibm.etools.emf.ecore.EEnumLiteral value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the new value of the 'Constraint' attribute.
See Also:
setConstraint(int), setConstraint(Integer), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getLiteralConstraint()

setConstraint

public void setConstraint(int value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(Integer), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getValueConstraint()

setConstraint

public void setConstraint(java.lang.String value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(int), setConstraint(Integer), XSDConstraint, isSetConstraint(), unsetConstraint(), getStringConstraint()

setConstraint

public void setConstraint(java.lang.Integer value)
                   throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Constraint' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Constraint' attribute.
See Also:
setConstraint(EEnumLiteral), setConstraint(int), setConstraint(String), XSDConstraint, isSetConstraint(), unsetConstraint(), getValueConstraint()

unsetConstraint

public void unsetConstraint()
Unsets the value of the 'Constraint' attribute.
See Also:
isSetConstraint(), getLiteralConstraint(), setConstraint(EEnumLiteral)

isSetConstraint

public boolean isSetConstraint()
Returns whether the value of the 'Constraint' attribute is set.
Returns:
whether the value of the 'Constraint' attribute is set.
See Also:
unsetConstraint(), getLiteralConstraint(), setConstraint(EEnumLiteral)

getLiteralUse

public com.ibm.etools.emf.ecore.EEnumLiteral getLiteralUse()
Returns the value of the 'Use' attribute. The literals are from the enumeration XSDAttributeUseCategory.

This concrete attribute represents the value of the use attribute.

Returns:
the value of the 'Use' attribute.
See Also:
getValueUse(), getUse(), getStringUse(), XSDAttributeUseCategory, isSetUse(), unsetUse(), setUse(EEnumLiteral), XSDPackage.getXSDAttributeUse_Use()

getValueUse

public int getValueUse()
Returns the primitive value of the 'Use' attribute.
Returns:
the primitive value of the 'Use' attribute.
See Also:
getLiteralUse(), getValueUse(), getStringUse(), XSDAttributeUseCategory, isSetUse(), unsetUse(), setUse(int)

getStringUse

public java.lang.String getStringUse()
Returns the String value of the 'Use' attribute.
Returns:
the String value of the 'Use' attribute.
See Also:
getLiteralUse(), getUse(), getValueUse(), XSDAttributeUseCategory, isSetUse(), unsetUse(), setUse(String)

getUse

public java.lang.Integer getUse()
Returns the Integer value of the 'Use' attribute.
Returns:
the Integer value of the 'Use' attribute.
See Also:
getLiteralUse(), getValueUse(), getStringUse(), XSDAttributeUseCategory, isSetUse(), unsetUse(), setUse(Integer)

setUse

public void setUse(com.ibm.etools.emf.ecore.EEnumLiteral value)
            throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Use' attribute.
Parameters:
value - the new value of the 'Use' attribute.
See Also:
setUse(int), setUse(Integer), setUse(String), XSDAttributeUseCategory, isSetUse(), unsetUse(), getLiteralUse()

setUse

public void setUse(int value)
            throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Use' attribute.
Parameters:
value - the int value of the new enumeration literal value of the 'Use' attribute.
See Also:
setUse(EEnumLiteral), setUse(Integer), setUse(String), XSDAttributeUseCategory, isSetUse(), unsetUse(), getValueUse()

setUse

public void setUse(java.lang.String value)
            throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Use' attribute.
Parameters:
value - the String value of the new enumeration literal value of the 'Use' attribute.
See Also:
setUse(EEnumLiteral), setUse(int), setUse(Integer), XSDAttributeUseCategory, isSetUse(), unsetUse(), getStringUse()

setUse

public void setUse(java.lang.Integer value)
            throws com.ibm.etools.emf.ref.EnumerationException
Sets the value of the 'Use' attribute.
Parameters:
value - the Integer value of the new enumeration literal value of the 'Use' attribute.
See Also:
setUse(EEnumLiteral), setUse(int), setUse(String), XSDAttributeUseCategory, isSetUse(), unsetUse(), getValueUse()

unsetUse

public void unsetUse()
Unsets the value of the 'Use' attribute.
See Also:
isSetUse(), getLiteralUse(), setUse(EEnumLiteral)

isSetUse

public boolean isSetUse()
Returns whether the value of the 'Use' attribute is set.
Returns:
whether the value of the 'Use' attribute is set.
See Also:
unsetUse(), getLiteralUse(), setUse(EEnumLiteral)

getLexicalValue

public java.lang.String getLexicalValue()
Returns the value of the 'Lexical Value' attribute.

This concrete attribute represents the value of the default or fixed attribute.

Returns:
the value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), unsetLexicalValue(), setLexicalValue(String), XSDPackage.getXSDAttributeUse_LexicalValue()

setLexicalValue

public void setLexicalValue(java.lang.String value)
Sets the value of the 'Lexical Value' attribute.
Parameters:
value - the new value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), unsetLexicalValue(), getLexicalValue()

unsetLexicalValue

public void unsetLexicalValue()
Unsets the value of the 'Lexical Value' attribute.
See Also:
isSetLexicalValue(), getLexicalValue(), setLexicalValue(String)

isSetLexicalValue

public boolean isSetLexicalValue()
Returns whether the value of the 'Lexical Value' attribute is set.
Returns:
whether the value of the 'Lexical Value' attribute is set.
See Also:
unsetLexicalValue(), getLexicalValue(), setLexicalValue(String)

getAttributeDeclaration

public XSDAttributeDeclaration getAttributeDeclaration()
Returns the value of the 'Attribute Declaration' reference.

This represents the attribute infoset property. It is computed from the content and should typically not be set directly.

Returns:
the value of the 'Attribute Declaration' reference.
See Also:
isSetAttributeDeclaration(), unsetAttributeDeclaration(), setAttributeDeclaration(XSDAttributeDeclaration), XSDPackage.getXSDAttributeUse_AttributeDeclaration()

setAttributeDeclaration

public void setAttributeDeclaration(XSDAttributeDeclaration value)
Sets the value of the 'Attribute Declaration' reference.
Parameters:
value - the new value of the 'Attribute Declaration' reference.
See Also:
isSetAttributeDeclaration(), unsetAttributeDeclaration(), getAttributeDeclaration()

unsetAttributeDeclaration

public void unsetAttributeDeclaration()
Unsets the value of the 'Attribute Declaration' reference.
See Also:
isSetAttributeDeclaration(), getAttributeDeclaration(), setAttributeDeclaration(XSDAttributeDeclaration)

isSetAttributeDeclaration

public boolean isSetAttributeDeclaration()
Returns whether the value of the 'Attribute Declaration' reference is set.
Returns:
whether the value of the 'Attribute Declaration' reference is set.
See Also:
unsetAttributeDeclaration(), getAttributeDeclaration(), setAttributeDeclaration(XSDAttributeDeclaration)

getContent

public XSDAttributeDeclaration getContent()
Returns the value of the 'Content' reference.

This concrete reference represents the underlying concrete attribute element.

Returns:
the value of the 'Content' reference.
See Also:
isSetContent(), unsetContent(), setContent(XSDAttributeDeclaration), XSDPackage.getXSDAttributeUse_Content()

setContent

public void setContent(XSDAttributeDeclaration value)
Sets the value of the 'Content' reference.
Parameters:
value - the new value of the 'Content' reference.
See Also:
isSetContent(), unsetContent(), getContent()

unsetContent

public void unsetContent()
Unsets the value of the 'Content' reference.
See Also:
isSetContent(), getContent(), setContent(XSDAttributeDeclaration)

isSetContent

public boolean isSetContent()
Returns whether the value of the 'Content' reference is set.
Returns:
whether the value of the 'Content' reference is set.
See Also:
unsetContent(), getContent(), setContent(XSDAttributeDeclaration)