com.esri.aims.mtier.model.metadata.query
Class CollectionInfo

java.lang.Object
  |
  +--com.esri.aims.mtier.model.metadata.query.CollectionInfo

public class CollectionInfo
extends Object

Acquires information about the metadata repository as a whole.


Field Summary
static int ALPHABETIC
          used to order returns.
static int FREQUENCY
          Deprecated. As of ArcIMS 4.0.1 - MetadataServer does not support FREQUENCY order.
static int QUERIES
          used to order returns.
static int TAGS
          defines the collection of objects to search
static int WORDS
          defines the collection of objects to search
 
Constructor Summary
CollectionInfo()
          Constructs an instance of a CollectionInfo object.
 
Method Summary
 com.esri.w3c.dom.Element getCollectionInfoElement()
          Returns this object as an Element so that it may be used in XML documents.
 int getCollectionType()
          Returns the type of collection contained.
 int getOrderBy()
          Returns the order by value.
 String getTagPath()
          Returns the tag path for this object.
 int getZCode()
          Returns the zCode.
 void setCollectionType(int newCollectionType)
          Sets the type of collection contained.
 void setOrderBy(int newOrderBy)
          Sets the order by value using the static constants of this object.
 void setTagPath(String newTagPath)
          Sets the tag path to get a collection from.
 void setZCode(int newZCode)
          Sets the zCode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WORDS

public static final int WORDS
defines the collection of objects to search

See Also:
Constant Field Values

TAGS

public static final int TAGS
defines the collection of objects to search

See Also:
Constant Field Values

ALPHABETIC

public static final int ALPHABETIC
used to order returns.

See Also:
Constant Field Values

FREQUENCY

public static final int FREQUENCY
Deprecated. As of ArcIMS 4.0.1 - MetadataServer does not support FREQUENCY order.

See Also:
Constant Field Values

QUERIES

public static final int QUERIES
used to order returns.

See Also:
Constant Field Values
Constructor Detail

CollectionInfo

public CollectionInfo()
Constructs an instance of a CollectionInfo object.

Method Detail

setCollectionType

public void setCollectionType(int newCollectionType)
Sets the type of collection contained.


getCollectionType

public int getCollectionType()
Returns the type of collection contained.


setTagPath

public void setTagPath(String newTagPath)
Sets the tag path to get a collection from.


getTagPath

public String getTagPath()
Returns the tag path for this object.


setZCode

public void setZCode(int newZCode)
Sets the zCode.


getZCode

public int getZCode()
Returns the zCode.


setOrderBy

public void setOrderBy(int newOrderBy)
Sets the order by value using the static constants of this object.


getOrderBy

public int getOrderBy()
Returns the order by value.


getCollectionInfoElement

public com.esri.w3c.dom.Element getCollectionInfoElement()
                                                  throws AXLAttributeException
Returns this object as an Element so that it may be used in XML documents.

AXLAttributeException