com.novell.zos.grid
Interface Message.GetGridObjects

Enclosing interface:

Message

public static interface Message.GetGridObjects

Client request to retrieve an (optionally ordered) set of grid objects that match a search criteria (constraint).

Method Summary

Constraint	getConstraint() The constraint used in search.
String	getConstraintStr() The constraint string used in search.
boolean	getFetchFacts() Whether or not to retrieve the factset associated with grid object.
String	getObjectName() The name of the grid object required.
String	getObjectType() Type of grid object being searched for.
String[]	getRankBy() Rankby specification for searching or null if not important.

Method Detail

getObjectType

String getObjectType()

Type of grid object being searched for.

Returns:

grid object type

getObjectName

String getObjectName()

The name of the grid object required. Not expected if RankBy and Constraint are set. If set, then at most, only one grid object info will be returned.

Returns:

grid object name

getRankBy

String[] getRankBy()

Rankby specification for searching or null if not important.

Returns:

the rankby specification

getConstraint

Constraint getConstraint()

The constraint used in search. And'd with ConstraintStr if it is also specified.

Returns:

the search constraint

getConstraintStr

String getConstraintStr()

The constraint string used in search. And'd with Constraint if it is also specified.

Returns:

the search constraint

getFetchFacts

boolean getFetchFacts()

Whether or not to retrieve the factset associated with grid object.

Returns:

true if facts are required