edu.internet2.middleware.grouperClient.ws.beans
Class WsRestAssignAttributesRequest

java.lang.Object
  extended by edu.internet2.middleware.grouperClient.ws.beans.WsRestAssignAttributesRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestAssignAttributesRequest
extends Object
implements WsRequestBean

request bean in body of rest request


Constructor Summary
WsRestAssignAttributesRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
          if acting as someone else
 String[] getActions()
          actions to query, or none to query all actions
 String[] getActionsToReplace()
          if replacing attributeDefNames, then these are the related actions, if blank, then just do all
 String getAssignmentDisabledTime()
          disabled time, or null for not disabled
 String getAssignmentEnabledTime()
          enabled time, or null for enabled now
 String getAssignmentNotes()
          notes on the assignment (optional)
 String getAttributeAssignOperation()
          operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr
 String getAttributeAssignType()
          is the attribute assign type we are looking for
 String getAttributeAssignValueOperation()
          operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values
 WsAttributeDefLookup[] getAttributeDefsToReplace()
          if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
 String[] getAttributeDefTypesToReplace()
          if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all
 String getClientVersion()
          is the version of the client.
 String getDelegatable()
          really only for permissions, if the assignee can delegate to someone else.
 String getIncludeGroupDetail()
          T or F as to if the group detail should be returned
 String getIncludeSubjectDetail()
          T|F, for if the extended subject information should be returned (anything more than just the id)
 WsParam[] getParams()
          optional: reserved for future use
 String[] getSubjectAttributeNames()
          are the additional subject attributes (data) to return.
 WsAttributeAssignValue[] getValues()
          are the values to assign, replace, remove, etc.
 WsAttributeAssignLookup[] getWsAttributeAssignLookups()
          if you know the assign ids you want, put them here
 WsAttributeDefNameLookup[] getWsAttributeDefNameLookups()
          find assignments in these attribute def names (optional)
 WsAttributeAssignLookup[] getWsOwnerAttributeAssignLookups()
          for assignment on assignment
 WsAttributeDefLookup[] getWsOwnerAttributeDefLookups()
          to query attributes assigned on attribute defs
 WsGroupLookup[] getWsOwnerGroupLookups()
          wsOwnerGroupLookups are groups to look in
 WsMembershipAnyLookup[] getWsOwnerMembershipAnyLookups()
          to query attributes in "any" memberships which are on immediate or effective memberships
 WsMembershipLookup[] getWsOwnerMembershipLookups()
          to query attributes on immediate memberships
 WsStemLookup[] getWsOwnerStemLookups()
          are stems to look in
 WsSubjectLookup[] getWsOwnerSubjectLookups()
          are subjects to look in
 void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
          if acting as someone else
 void setActions(String[] actions1)
          actions to query, or none to query all actions
 void setActionsToReplace(String[] actionsToReplace1)
          if replacing attributeDefNames, then these are the related actions, if blank, then just do all
 void setAssignmentDisabledTime(String assignmentDisabledTime1)
          disabled time, or null for not disabled
 void setAssignmentEnabledTime(String assignmentEnabledTime1)
          enabled time, or null for enabled now
 void setAssignmentNotes(String assignmentNotes1)
          notes on the assignment (optional)
 void setAttributeAssignOperation(String attributeAssignOperation1)
          operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr
 void setAttributeAssignType(String attributeAssignType1)
          is the attribute assign type we are looking for
 void setAttributeAssignValueOperation(String attributeAssignValueOperation1)
          operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values
 void setAttributeDefsToReplace(WsAttributeDefLookup[] attributeDefsToReplace1)
          if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all
 void setAttributeDefTypesToReplace(String[] attributeDefTypesToReplace1)
          if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all
 void setClientVersion(String clientVersion1)
          is the version of the client.
 void setDelegatable(String delegatable1)
          really only for permissions, if the assignee can delegate to someone else.
 void setIncludeGroupDetail(String includeGroupDetail1)
          T or F as to if the group detail should be returned
 void setIncludeSubjectDetail(String includeSubjectDetail1)
          T|F, for if the extended subject information should be returned (anything more than just the id)
 void setParams(WsParam[] params1)
          optional: reserved for future use
 void setSubjectAttributeNames(String[] subjectAttributeNames1)
          are the additional subject attributes (data) to return.
 void setValues(WsAttributeAssignValue[] values1)
          are the values to assign, replace, remove, etc.
 void setWsAttributeAssignLookups(WsAttributeAssignLookup[] wsAttributeAssignLookups1)
          if you know the assign ids you want, put them here
 void setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
          find assignments in these attribute def names (optional)
 void setWsOwnerAttributeAssignLookups(WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups1)
          for assignment on assignment
 void setWsOwnerAttributeDefLookups(WsAttributeDefLookup[] wsOwnerAttributeDefLookups1)
          to query attributes assigned on attribute defs
 void setWsOwnerGroupLookups(WsGroupLookup[] wsOwnerGroupLookups1)
          wsOwnerGroupLookups are groups to look in
 void setWsOwnerMembershipAnyLookups(WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups1)
          to query attributes in "any" memberships which are on immediate or effective memberships
 void setWsOwnerMembershipLookups(WsMembershipLookup[] wsOwnerMembershipLookups1)
          to query attributes on immediate memberships
 void setWsOwnerStemLookups(WsStemLookup[] wsOwnerStemLookups1)
          are stems to look in
 void setWsOwnerSubjectLookups(WsSubjectLookup[] wsOwnerSubjectLookups1)
          are subjects to look in
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WsRestAssignAttributesRequest

public WsRestAssignAttributesRequest()
Method Detail

getAssignmentNotes

public String getAssignmentNotes()
notes on the assignment (optional)

Returns:
notes

setAssignmentNotes

public void setAssignmentNotes(String assignmentNotes1)
notes on the assignment (optional)

Parameters:
assignmentNotes1 -

getAssignmentEnabledTime

public String getAssignmentEnabledTime()
enabled time, or null for enabled now

Returns:
enabled time

setAssignmentEnabledTime

public void setAssignmentEnabledTime(String assignmentEnabledTime1)
enabled time, or null for enabled now

Parameters:
assignmentEnabledTime1 -

getAssignmentDisabledTime

public String getAssignmentDisabledTime()
disabled time, or null for not disabled

Returns:
disabled time

setAssignmentDisabledTime

public void setAssignmentDisabledTime(String assignmentDisabledTime1)
disabled time, or null for not disabled

Parameters:
assignmentDisabledTime1 -

getDelegatable

public String getDelegatable()
really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT

Returns:
delegatable

setDelegatable

public void setDelegatable(String delegatable1)
really only for permissions, if the assignee can delegate to someone else. TRUE|FALSE|GRANT

Parameters:
delegatable1 -

getAttributeAssignValueOperation

public String getAttributeAssignValueOperation()
operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values

Returns:
operation

setAttributeAssignValueOperation

public void setAttributeAssignValueOperation(String attributeAssignValueOperation1)
operation to perform for attribute value on attribute assignments: assign_value, add_value, remove_value, replace_values

Parameters:
attributeAssignValueOperation1 -

getWsOwnerAttributeAssignLookups

public WsAttributeAssignLookup[] getWsOwnerAttributeAssignLookups()
for assignment on assignment

Returns:
assignment lookup

setWsOwnerAttributeAssignLookups

public void setWsOwnerAttributeAssignLookups(WsAttributeAssignLookup[] wsOwnerAttributeAssignLookups1)
for assignment on assignment

Parameters:
wsOwnerAttributeAssignLookups1 -

getAttributeAssignOperation

public String getAttributeAssignOperation()
operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr

Returns:
operation

setAttributeAssignOperation

public void setAttributeAssignOperation(String attributeAssignOperation1)
operation to perform for attribute on owners, from enum AttributeAssignOperation assign_attr, add_attr, remove_attr

Parameters:
attributeAssignOperation1 -

getValues

public WsAttributeAssignValue[] getValues()
are the values to assign, replace, remove, etc. If removing, and id is specified, will only remove values with that id.

Returns:
values

setValues

public void setValues(WsAttributeAssignValue[] values1)
are the values to assign, replace, remove, etc. If removing, and id is specified, will only remove values with that id.

Parameters:
values1 -

getClientVersion

public String getClientVersion()
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Returns:
version

setClientVersion

public void setClientVersion(String clientVersion1)
is the version of the client. Must be in GrouperWsVersion, e.g. v1_3_000

Parameters:
clientVersion1 -

getAttributeAssignType

public String getAttributeAssignType()
is the attribute assign type we are looking for

Returns:
attribute assign type

setAttributeAssignType

public void setAttributeAssignType(String attributeAssignType1)
is the attribute assign type we are looking for

Parameters:
attributeAssignType1 -

getWsAttributeAssignLookups

public WsAttributeAssignLookup[] getWsAttributeAssignLookups()
if you know the assign ids you want, put them here

Returns:
attribute assign lookups

setWsAttributeAssignLookups

public void setWsAttributeAssignLookups(WsAttributeAssignLookup[] wsAttributeAssignLookups1)
if you know the assign ids you want, put them here

Parameters:
wsAttributeAssignLookups1 -

getWsAttributeDefNameLookups

public WsAttributeDefNameLookup[] getWsAttributeDefNameLookups()
find assignments in these attribute def names (optional)

Returns:
def name lookups

setWsAttributeDefNameLookups

public void setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
find assignments in these attribute def names (optional)

Parameters:
wsAttributeDefNameLookups1 -

getWsOwnerGroupLookups

public WsGroupLookup[] getWsOwnerGroupLookups()
wsOwnerGroupLookups are groups to look in

Returns:
owner group lookups

setWsOwnerGroupLookups

public void setWsOwnerGroupLookups(WsGroupLookup[] wsOwnerGroupLookups1)
wsOwnerGroupLookups are groups to look in

Parameters:
wsOwnerGroupLookups1 -

getWsOwnerStemLookups

public WsStemLookup[] getWsOwnerStemLookups()
are stems to look in

Returns:
are stems to look in

setWsOwnerStemLookups

public void setWsOwnerStemLookups(WsStemLookup[] wsOwnerStemLookups1)
are stems to look in

Parameters:
wsOwnerStemLookups1 -

getWsOwnerSubjectLookups

public WsSubjectLookup[] getWsOwnerSubjectLookups()
are subjects to look in

Returns:
subject

setWsOwnerSubjectLookups

public void setWsOwnerSubjectLookups(WsSubjectLookup[] wsOwnerSubjectLookups1)
are subjects to look in

Parameters:
wsOwnerSubjectLookups1 -

getWsOwnerMembershipLookups

public WsMembershipLookup[] getWsOwnerMembershipLookups()
to query attributes on immediate memberships

Returns:
owner memberships

setWsOwnerMembershipLookups

public void setWsOwnerMembershipLookups(WsMembershipLookup[] wsOwnerMembershipLookups1)
to query attributes on immediate memberships

Parameters:
wsOwnerMembershipLookups1 -

getWsOwnerMembershipAnyLookups

public WsMembershipAnyLookup[] getWsOwnerMembershipAnyLookups()
to query attributes in "any" memberships which are on immediate or effective memberships

Returns:
any memberships

setWsOwnerMembershipAnyLookups

public void setWsOwnerMembershipAnyLookups(WsMembershipAnyLookup[] wsOwnerMembershipAnyLookups1)
to query attributes in "any" memberships which are on immediate or effective memberships

Parameters:
wsOwnerMembershipAnyLookups1 -

getWsOwnerAttributeDefLookups

public WsAttributeDefLookup[] getWsOwnerAttributeDefLookups()
to query attributes assigned on attribute defs

Returns:
attribute def

setWsOwnerAttributeDefLookups

public void setWsOwnerAttributeDefLookups(WsAttributeDefLookup[] wsOwnerAttributeDefLookups1)
to query attributes assigned on attribute defs

Parameters:
wsOwnerAttributeDefLookups1 -

getActions

public String[] getActions()
actions to query, or none to query all actions

Returns:
actions

setActions

public void setActions(String[] actions1)
actions to query, or none to query all actions

Parameters:
actions1 -

getActAsSubjectLookup

public WsSubjectLookup getActAsSubjectLookup()
if acting as someone else

Returns:
act as subject

setActAsSubjectLookup

public void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
if acting as someone else

Parameters:
actAsSubjectLookup1 -

getIncludeSubjectDetail

public String getIncludeSubjectDetail()
T|F, for if the extended subject information should be returned (anything more than just the id)

Returns:
T|F

setIncludeSubjectDetail

public void setIncludeSubjectDetail(String includeSubjectDetail1)
T|F, for if the extended subject information should be returned (anything more than just the id)

Parameters:
includeSubjectDetail1 -

getSubjectAttributeNames

public String[] getSubjectAttributeNames()
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent

Returns:
subject attribute names

setSubjectAttributeNames

public void setSubjectAttributeNames(String[] subjectAttributeNames1)
are the additional subject attributes (data) to return. If blank, whatever is configured in the grouper-ws.properties will be sent

Parameters:
subjectAttributeNames1 -

getIncludeGroupDetail

public String getIncludeGroupDetail()
T or F as to if the group detail should be returned

Returns:
T|F

setIncludeGroupDetail

public void setIncludeGroupDetail(String includeGroupDetail1)
T or F as to if the group detail should be returned

Parameters:
includeGroupDetail1 -

getParams

public WsParam[] getParams()
optional: reserved for future use

Returns:
params

setParams

public void setParams(WsParam[] params1)
optional: reserved for future use

Parameters:
params1 -

getActionsToReplace

public String[] getActionsToReplace()
if replacing attributeDefNames, then these are the related actions, if blank, then just do all

Returns:
the actionsToReplace

getAttributeDefsToReplace

public WsAttributeDefLookup[] getAttributeDefsToReplace()
if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all

Returns:
the attributeDefsToReplace

getAttributeDefTypesToReplace

public String[] getAttributeDefTypesToReplace()
if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all

Returns:
the attributeDefTypesToReplace

setActionsToReplace

public void setActionsToReplace(String[] actionsToReplace1)
if replacing attributeDefNames, then these are the related actions, if blank, then just do all

Parameters:
actionsToReplace1 - the actionsToReplace to set

setAttributeDefsToReplace

public void setAttributeDefsToReplace(WsAttributeDefLookup[] attributeDefsToReplace1)
if replacing attributeDefNames, then these are the related attributeDefs, if blank, then just do all

Parameters:
attributeDefsToReplace1 - the attributeDefsToReplace to set

setAttributeDefTypesToReplace

public void setAttributeDefTypesToReplace(String[] attributeDefTypesToReplace1)
if replacing attributeDefNames, then these are the related attributeDefTypes, if blank, then just do all

Parameters:
attributeDefTypesToReplace1 - the attributeDefTypesToReplace to set