org.ogf.saga.attributes
Interface AsyncAttributes<T>

All Superinterfaces:

Attributes

All Known Subinterfaces:

Job, JobSelf, LogicalDirectory, LogicalFile, Stream

public interface AsyncAttributes<T>
extends Attributes

Task versions of all methods from the Attributes interface. The generic type T specifies the object type that implements this interface.

Field Summary

Fields inherited from interface org.ogf.saga.attributes.Attributes

BOOL, ENUM, FALSE, FLOAT, INT, STRING, TIME, TRIGGER, TRUE

Method Summary

Task<T,Boolean>	existsAttribute(TaskMode mode, String key) Creates a task that tests for the existence of an attribute.
Task<T,String[]>	findAttributes(TaskMode mode, String... patterns) Creates a task that finds matching attributes.
Task<T,String>	getAttribute(TaskMode mode, String key) Creates a task that obtains the value of an attribute.
Task<T,String[]>	getVectorAttribute(TaskMode mode, String key) Creates a task that obtains the array of values associated with an attribute.
Task<T,Boolean>	isReadOnlyAttribute(TaskMode mode, String key) Creates a task that checks the attribute mode for being read-only.
Task<T,Boolean>	isRemovableAttribute(TaskMode mode, String key) Creates a task that checks the attribute mode for being removable.
Task<T,Boolean>	isVectorAttribute(TaskMode mode, String key) Creates a task that checks the attribute mode for being a vector.
Task<T,Boolean>	isWritableAttribute(TaskMode mode, String key) Creates a task that checks the attribute mode for being writable.
Task<T,String[]>	listAttributes(TaskMode mode) Creates a task that obtains the list of attribute keys.
Task<T,Void>	removeAttribute(TaskMode mode, String key) Creates a task that removes an attribute.
Task<T,Void>	setAttribute(TaskMode mode, String key, String value) Creates a task that sets an attribute to a value.
Task<T,Void>	setVectorAttribute(TaskMode mode, String key, String[] values) Creates a task that sets an attribute to an array of values.

Methods inherited from interface org.ogf.saga.attributes.Attributes

existsAttribute, findAttributes, getAttribute, getVectorAttribute, isReadOnlyAttribute, isRemovableAttribute, isVectorAttribute, isWritableAttribute, listAttributes, removeAttribute, setAttribute, setVectorAttribute

Method Detail

setAttribute

Task<T,Void> setAttribute(TaskMode mode,
                          String key,
                          String value)
                          throws NotImplementedException

Creates a task that sets an attribute to a value.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

value - value to set the attribute to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getAttribute

Task<T,String> getAttribute(TaskMode mode,
                            String key)
                            throws NotImplementedException

Creates a task that obtains the value of an attribute.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

setVectorAttribute

Task<T,Void> setVectorAttribute(TaskMode mode,
                                String key,
                                String[] values)
                                throws NotImplementedException

Creates a task that sets an attribute to an array of values.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

values - values to set the attribute to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getVectorAttribute

Task<T,String[]> getVectorAttribute(TaskMode mode,
                                    String key)
                                    throws NotImplementedException

Creates a task that obtains the array of values associated with an attribute.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

removeAttribute

Task<T,Void> removeAttribute(TaskMode mode,
                             String key)
                             throws NotImplementedException

Creates a task that removes an attribute.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

listAttributes

Task<T,String[]> listAttributes(TaskMode mode)
                                throws NotImplementedException

Creates a task that obtains the list of attribute keys.

Parameters:

mode - determines the initial state of the task.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

findAttributes

Task<T,String[]> findAttributes(TaskMode mode,
                                String... patterns)
                                throws NotImplementedException

Creates a task that finds matching attributes.

Parameters:

mode - determines the initial state of the task.

patterns - the search patterns.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

existsAttribute

Task<T,Boolean> existsAttribute(TaskMode mode,
                                String key)
                                throws NotImplementedException

Creates a task that tests for the existence of an attribute.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isReadOnlyAttribute

Task<T,Boolean> isReadOnlyAttribute(TaskMode mode,
                                    String key)
                                    throws NotImplementedException

Creates a task that checks the attribute mode for being read-only.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isWritableAttribute

Task<T,Boolean> isWritableAttribute(TaskMode mode,
                                    String key)
                                    throws NotImplementedException

Creates a task that checks the attribute mode for being writable.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isRemovableAttribute

Task<T,Boolean> isRemovableAttribute(TaskMode mode,
                                     String key)
                                     throws NotImplementedException

Creates a task that checks the attribute mode for being removable.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isVectorAttribute

Task<T,Boolean> isVectorAttribute(TaskMode mode,
                                  String key)
                                  throws NotImplementedException

Creates a task that checks the attribute mode for being a vector.

Parameters:

mode - determines the initial state of the task.

key - the attribute key.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.