/*

 * reserved comment block

 * DO NOT REMOVE OR ALTER!

 */

/*

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.sun.org.apache.xerces.internal.xs;

/**

 * This interface represents the Attribute Use schema component.

 */

public interface XSAttributeUse extends XSObject {

    /**

     * [required]: determines whether this use of an attribute declaration

     * requires an appropriate attribute information item to be present, or

     * merely allows it.

     */

    public boolean getRequired();

    /**

     * [attribute declaration]: provides the attribute declaration itself,

     * which will in turn determine the simple type definition used.

     */

    public XSAttributeDeclaration getAttrDeclaration();

    /**

     */

    public short getConstraintType();

    /**

     * Value Constraint: The constraint value, otherwise <code>null</code>.

     */

    public String getConstraintValue();

    /**

     * Value Constraint: Binding specific actual constraint value or

     * <code>null</code> if the value is in error or there is no value

     * constraint.

     * @exception XSException

     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this

     *   method.

     */

    public Object getActualVC()

                                       throws XSException;

    /**

     * The actual constraint value built-in datatype, e.g.

     * <code>STRING_DT, SHORT_DT</code>. If the type definition of this

     * value is a list type definition, this method returns

     * <code>LIST_DT</code>. If the type definition of this value is a list

     * type definition whose item type is a union type definition, this

     * method returns <code>LISTOFUNION_DT</code>. To query the actual

     * constraint value of the list or list of union type definitions use

     * <code>itemValueTypes</code>. If the <code>actualNormalizedValue</code>

     * @exception XSException

     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this

     *   method.

     */

    public short getActualVCType()

                                       throws XSException;

    /**

     * In the case the actual constraint value represents a list, i.e. the

     * <code>actualValueType</code> is <code>LIST_DT</code>, the returned

     * array consists of one type kind which represents the itemType. If the

     * actual constraint value represents a list type definition whose item

     * type is a union type definition, i.e. <code>LISTOFUNION_DT</code>,

     * for each actual constraint value in the list the array contains the

     * corresponding memberType kind. For examples, see

     * <code>ItemPSVI.itemValueTypes</code>.

     * @exception XSException

     *   NOT_SUPPORTED_ERR: Raised if the implementation does not support this

     *   method.

     */

    public ShortList getItemValueTypes()

                                       throws XSException;

    /**

     * A sequence of [annotations] or an empty <code>XSObjectList</code>.

     */

    public XSObjectList getAnnotations();

}