diff options
| author | Andrew Branson <andrew.branson@cern.ch> | 2014-06-21 23:46:54 +0200 |
|---|---|---|
| committer | Andrew Branson <andrew.branson@cern.ch> | 2014-06-21 23:46:54 +0200 |
| commit | 7960b09436ff7eac409a91253dace863750e1120 (patch) | |
| tree | 3daec181cc4849f257bcb6160bf4340cf797375a | |
| parent | 27718ce674b4bae9e1744bb76e8a2a7c32df9379 (diff) | |
Javadoc for Job query methods
| -rw-r--r-- | src/main/java/com/c2kernel/entity/proxy/ItemProxy.java | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/main/java/com/c2kernel/entity/proxy/ItemProxy.java b/src/main/java/com/c2kernel/entity/proxy/ItemProxy.java index 67685e7..077ddf8 100644 --- a/src/main/java/com/c2kernel/entity/proxy/ItemProxy.java +++ b/src/main/java/com/c2kernel/entity/proxy/ItemProxy.java @@ -177,6 +177,15 @@ public class ItemProxy extends EntityProxy return thisJobList.list;
}
+ /**
+ * Returns all Jobs (possible state transitions in all active Activities) that the given Agent may perform in this Item.
+ *
+ * @param agent - the Agent who will perform the execution
+ * @return ArrayList of Jobs
+ * @throws AccessRightsException
+ * @throws ObjectNotFoundException
+ * @throws PersistencyException
+ */
public ArrayList<Job> getJobList(AgentProxy agent)
throws AccessRightsException,
ObjectNotFoundException,
@@ -221,6 +230,16 @@ public class ItemProxy extends EntityProxy return (Viewpoint)getObject(ClusterStorage.VIEWPOINT+"/"+schemaName+"/"+viewName);
}
+ /**
+ * Queries for DONE or COMPLETE Jobs in the named Activity
+ *
+ * @param actName The activity name to search for
+ * @param agent The agent who will be performing the transition
+ * @return A Job object to complete the named Activity
+ * @throws AccessRightsException
+ * @throws ObjectNotFoundException
+ * @throws PersistencyException
+ */
public Job getJobByName(String actName, AgentProxy agent)
throws AccessRightsException,
ObjectNotFoundException,
|