org.norther.tammi.spray.db.step
Class UserGroupAction

java.lang.Object
  extended by org.norther.tammi.spray.loader.task.Action
      extended by org.norther.tammi.spray.loader.task.Submit
          extended by org.norther.tammi.spray.template.step.FlowStepAction
              extended by org.norther.tammi.spray.template.step.NextStepAction
                  extended by org.norther.tammi.spray.template.step.FormStepAction
                      extended by org.norther.tammi.spray.db.step.RepositoryStepAction
                          extended by org.norther.tammi.spray.db.step.SelectionStepAction
                              extended by org.norther.tammi.spray.db.step.ElementStepAction
                                  extended by org.norther.tammi.spray.db.step.UserGroupAction
All Implemented Interfaces:
Serializable, Task
Direct Known Subclasses:
UserGroupAction.Attach, UserGroupAction.Attached, UserGroupAction.Delete, UserGroupAction.Detach, UserGroupAction.Found, UserGroupAction.Insert, UserGroupAction.Join, UserGroupAction.Joined, UserGroupAction.Member, UserGroupAction.Move, UserGroupAction.Own, UserGroupAction.Quit, UserGroupAction.Search, UserGroupAction.Update

public abstract class UserGroupAction
extends ElementStepAction

A flow step action for managing user groups.

Note that an optional locale variant is interpreted as a user specific skin.

Version:
$Id: UserGroupAction.java,v 1.55 2010-08-24 12:50:11 cvsimp Exp $
Author:
Ilkka Priha
See Also:
Serialized Form

Nested Class Summary
static class UserGroupAction.Attach
          An attach group action.
static class UserGroupAction.Attached
          A select attached group action.
static class UserGroupAction.Delete
          A delete group action.
static class UserGroupAction.Detach
          A detach group action.
static class UserGroupAction.Found
          A select found group action.
static class UserGroupAction.Insert
          An insert group action.
static class UserGroupAction.Join
          A join group action.
static class UserGroupAction.Joined
          A select joined group action.
static class UserGroupAction.Member
          A select member group action.
static class UserGroupAction.Move
          A move group action.
static class UserGroupAction.Own
          A select own group action.
static class UserGroupAction.Quit
          A quit group action.
static class UserGroupAction.Search
          A search group action.
static class UserGroupAction.Update
          An update group action.
 
Nested classes/interfaces inherited from interface org.norther.tammi.spray.loader.task.Task
Task.Control
 
Field Summary
 
Fields inherited from class org.norther.tammi.spray.db.step.ElementStepAction
META_IDENTITY_PARAMETER, NEW_METADATA_ATTRIBUTES
 
Fields inherited from class org.norther.tammi.spray.loader.task.Submit
EXECUTE_METHOD, SUBMIT_PREFIX
 
Constructor Summary
UserGroupAction()
          Constructs a new flow step action.
 
Method Summary
 void attachSubgroup(Identity id, Variable var, Persister persister, FilterChain chain)
          Attaches the specified subgroup.
 void detachSubgroup(Identity id, Variable var, Persister persister, FilterChain chain)
          Detaches the specified subgroup.
protected  void finishJoinedGroup(List<Variable> vars, Persister persister, FilterChain chain)
          Finishes the group after joining it.
protected  void finishQuittedGroup(List<Variable> vars, Persister persister, FilterChain chain)
          Finishes the group after quitting it.
 void joinUserGroup(Variable var, Persister persister, FilterChain chain)
          Joins the specified user group.
 Collection<? extends Variable> queryGroupVariables(Variable search, Persister persister, FilterChain chain, StepFlowContext context)
          Queries for group variables of the specified search.
 void quitUserGroup(Variable var, Persister persister, FilterChain chain)
          Quits the specified user group.
 
Methods inherited from class org.norther.tammi.spray.db.step.ElementStepAction
checkPermission, createPermissionCriteria, createUserPermissionCriteria, getGroupId, getImportedElement, getMetaRecordType, getMetaSelectionVariable, getMetaSelectionVariable, getMetaSelectionVariable, getSelectedFormPrefix, getSelectedIdentity, isGroupMember, isGroupOwner, prepareMetaElement, queryAllMemberGroups, queryChildMemberGroups, queryMetaElement, queryParentMemberGroups
 
Methods inherited from class org.norther.tammi.spray.db.step.SelectionStepAction
buildSearchVariable, clearSelectedIdentity, deleteVariables, digest, fillQueryCriteria, fillSelectionVariable, fillSelectionVariable, filterRoleEnumeration, getAccountIdentity, getImportedVariable, getImportedVariables, getMandatorySelection, getSearchVariable, getSelectedIdentities, getSelectedIdentity, getSelectedIndex, getSelectedIndices, getSelectedVariable, getSelectionEnumeration, getSelectionEnumeration, getSelectionVariable, getSelectionVariable, getSelectionVariable, getStepClassName, getStepFieldNames, getStepMetaNames, getStepPermission, getUserId, insertVariables, queryAccountVariable, queryAllVariables, queryAllVariables, queryTreeVariables, submitDeleteVariable, submitDeleteVariables, submitDeleteVariables, submitInsertVariable, submitInsertVariables, submitInsertVariables, submitQueryVariable, submitSearchVariable, submitSelectAll, submitUnselectAll, submitUpdateVariable, submitUpdateVariables, submitUpdateVariables, updateVariables
 
Methods inherited from class org.norther.tammi.spray.db.step.RepositoryStepAction
add1NForeignReferences, add1NNullReferences, add1NObjectReferences, addAttributeValues, addToRelationMap, createVariable, createVariable, deleteReferences, deleteVariable, deleteVariable, getAttributeInfo, getAttributeValues, getDesktopData, getIntrospector, getLoader, getMetaDesktop, getMetaFolder, getPersister, getReferenceValue, getRepositoryFilter, getRootFolder, getRootReferences, getVariableInfo, insertReferences, insertVariable, insertVariable, isRelatedTo, orderObjects, queryAllObjects, queryAllObjects, queryTreeObjects, setMNForeignReferences, setMNObjectReferences, sortObjects, storeVariable, storeVariable, toClass, updateReferences, updateVariable, updateVariable
 
Methods inherited from class org.norther.tammi.spray.template.step.FormStepAction
clearParameters, loadPropertyFile, loadUploadedFile, submit, submitCancelStep, submitFinishStep, submitInsertForm, submitNextStep, submitPreviousStep, submitRenewForm, submitResetForm, submitReuseForm, submitUpdateForm, update, update, update, update
 
Methods inherited from class org.norther.tammi.spray.template.step.NextStepAction
isNextStepEnabled, setNextStepEnabled, submitBackStep
 
Methods inherited from class org.norther.tammi.spray.template.step.FlowStepAction
checkPermission, checkPermission, checkPermission, construct, execute, execute, finish, forward, getPermissibleRoles, getSignature, include, initialize, initialize, prepare, submit, submitOpenHelp
 
Methods inherited from class org.norther.tammi.spray.loader.task.Submit
getAction, getAction, invoke
 
Methods inherited from class org.norther.tammi.spray.loader.task.Action
find, find, getFilter, getMBeanServer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupAction

public UserGroupAction()
Constructs a new flow step action.

Method Detail

joinUserGroup

public void joinUserGroup(Variable var,
                          Persister persister,
                          FilterChain chain)
                   throws Exception
Joins the specified user group.

Parameters:
var - the group variable.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.

quitUserGroup

public void quitUserGroup(Variable var,
                          Persister persister,
                          FilterChain chain)
                   throws Exception
Quits the specified user group.

Parameters:
var - the variable.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.

attachSubgroup

public void attachSubgroup(Identity id,
                           Variable var,
                           Persister persister,
                           FilterChain chain)
                    throws Exception
Attaches the specified subgroup.

Parameters:
id - the subgroup identity.
var - the group variable.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.

detachSubgroup

public void detachSubgroup(Identity id,
                           Variable var,
                           Persister persister,
                           FilterChain chain)
                    throws Exception
Detaches the specified subgroup.

Parameters:
id - the subgroup identity.
var - the group variable.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.

queryGroupVariables

public Collection<? extends Variable> queryGroupVariables(Variable search,
                                                          Persister persister,
                                                          FilterChain chain,
                                                          StepFlowContext context)
                                                   throws Exception
Queries for group variables of the specified search.

Parameters:
search - the search variable.
persister - the persister.
chain - the filter chain.
context - the flow context.
Returns:
the group id.
Throws:
Exception - on errors.

finishJoinedGroup

protected void finishJoinedGroup(List<Variable> vars,
                                 Persister persister,
                                 FilterChain chain)
                          throws Exception
Finishes the group after joining it.

Parameters:
vars - the variables.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.

finishQuittedGroup

protected void finishQuittedGroup(List<Variable> vars,
                                  Persister persister,
                                  FilterChain chain)
                           throws Exception
Finishes the group after quitting it.

Parameters:
vars - the variables.
persister - the persister.
chain - the filter chain.
Throws:
Exception - on errors.


Copyright © 2004 The Norther Organization. All rights reserved.