com.f1j.data
Interface GrantExpressions


public interface GrantExpressions

This interface provides the API for adding, removing, and finding a GrantExpression within this collection.

Since:
12.0
See Also:
GrantExpression

Method Summary
 GrantExpression add(java.lang.String name, java.lang.String expression)
          Adds a new GrantExpression object with the specified name and grant expression.
 GrantExpression get(int index)
          Returns the GrantExpression with the specified index within this collection.
 GrantExpression get(java.lang.String name)
          Returns the GrantExpression with the specified name within this collection.
 int getCount()
          Returns the number of GrantExpression's in this collection.
 java.util.Iterator iterator()
          Returns an iterator over the GrantExpression's in this collection.
 void remove(java.lang.String name)
          Removes the GrantExpression with the specified name.
 

Method Detail

add

public GrantExpression add(java.lang.String name,
                           java.lang.String expression)
                    throws F1Exception
Adds a new GrantExpression object with the specified name and grant expression. The grant expression is specified in MatrixScript syntax.
Parameters:
name - The name of this grant expression.
expression - The grant expression in MatrixScript syntax.
Returns:
The new GrantExpression.
Throws:
F1Exception - if the specified name contains illegal characters or conflicts with an existing GrantExpression, or if the expression is invalid.
Since:
12.0
See Also:
GrantExpression

remove

public void remove(java.lang.String name)
Removes the GrantExpression with the specified name.
Parameters:
name - The name of the GrantExpression to be removed.
Since:
12.0
See Also:
GrantExpression

getCount

public int getCount()
Returns the number of GrantExpression's in this collection.
Returns:
the number of GrantExpression's in this collection.
Since:
12.0
See Also:
GrantExpression

get

public GrantExpression get(int index)
Returns the GrantExpression with the specified index within this collection.
Parameters:
index - The index of the GrantExpression to be found.
Returns:
The GrantExpression with the specified name or null if one does not exist with the name.
Throws:
java.lang.IndexOutOfBoundsException - if the index is invalid.
Since:
12.0
See Also:
GrantExpression

get

public GrantExpression get(java.lang.String name)
Returns the GrantExpression with the specified name within this collection. If a GrantExpression with the specified name cannot be found, then null is returned.
Parameters:
name - The name of the GrantExpression to be found.
Returns:
The GrantExpression with the specified name or null if one does not exist with the name.
Since:
12.0
See Also:
GrantExpression

iterator

public java.util.Iterator iterator()
Returns an iterator over the GrantExpression's in this collection.
Returns:
An iterator over the GrantExpression's in this collection.
Since:
12.0
See Also:
GrantExpression