com.sabratec.applinx.baseobject

Interface GXIScreenCollection

public interface GXIScreenCollection

This class represents a collection of screens. It is returned from a path response, and can also be created by you from an array of screens.

Method Summary

Modifier and Type	Method and Description
GXIFieldCollection	getFields(GXIScreenCollectionFieldsQuery query)
GXIFieldCollection	getFields(String fieldName) The method returns from all the screens in this collection all the fields that have the specified name.
GXIScreen	getScreenAt(int index)
int	getScreenCount()
GXIScreenCollection	getScreens(String screenName)

Method Detail

getScreenCount

int getScreenCount()

Returns:

the number of screens in the collection.

getScreenAt

GXIScreen getScreenAt(int index)

Parameters:

index - the index of the screen in the screens collection.

Returns:

the screen at the given index.

getFields

GXIFieldCollection getFields(GXIScreenCollectionFieldsQuery query)

Parameters:

query - the query for filtering the collection's data.

Returns:

the fields gathered by the given query, returned in the form of a field collection.

getFields

GXIFieldCollection getFields(String fieldName)

The method returns from all the screens in this collection all the fields that have the specified name. When the field is a multiple application field, each instance of the application field will be returned as a field in the collection.

Parameters:

fieldName - the name of the application field to return.

Returns:

all the instances of the given field name from ALL the screens in the collection.

getScreens

GXIScreenCollection getScreens(String screenName)

Parameters:

screenName - the name of the screen to return.

Returns:

a collection constructed from all the instances of the given screen name in the current collection.