edu.internet2.middleware.grouper.ws.rest.attribute
Class WsRestGetAttributeAssignmentsRequest

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.rest.attribute.WsRestGetAttributeAssignmentsRequest
All Implemented Interfaces:
WsRequestBean

public class WsRestGetAttributeAssignmentsRequest
extends Object
implements WsRequestBean

Bean for rest request to get attributes


Constructor Summary
WsRestGetAttributeAssignmentsRequest()
           
 
Method Summary
 WsSubjectLookup getActAsSubjectLookup()
          if acting as someone else
 String[] getActions()
          actions to query, or none to query all actions
 String getAttributeAssignType()
          is the attribute assign type we are looking for
 String getAttributeDefType()
          null for all, or specify an AttributeDefType e.g.
 String getAttributeDefValueType()
          required if sending theValue, can be: floating, integer, memberId, string, timestamp
 String getClientVersion()
          is the version of the client.
 String getEnabled()
          A for all, T or null for enabled only, F for disabled
 String getIncludeAssignmentsFromAssignments()
          T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well
 String getIncludeAssignmentsOnAssignments()
          if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
 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.
 String getTheValue()
          value if you are passing in one attributeDefNameLookup
 String[] getWsAssignAssignOwnerActions()
          if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to
 WsAttributeAssignLookup[] getWsAssignAssignOwnerAttributeAssignLookups()
          if looking for assignments on assignments, this is the assignment the assignment is assigned to
 WsAttributeDefLookup[] getWsAssignAssignOwnerAttributeDefLookups()
          if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to
 WsAttributeDefNameLookup[] getWsAssignAssignOwnerAttributeDefNameLookups()
          if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to
 WsAttributeAssignLookup[] getWsAttributeAssignLookups()
          if you know the assign ids you want, put them here
 WsAttributeDefLookup[] getWsAttributeDefLookups()
          find assignments in these attribute defs (optional)
 WsAttributeDefNameLookup[] getWsAttributeDefNameLookups()
          find assignments in these attribute def names (optional)
 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
 GrouperRestHttpMethod retrieveRestHttpMethod()
          see which http method this is supposed to be associated with, and override whatever was passed in
 void setActAsSubjectLookup(WsSubjectLookup actAsSubjectLookup1)
          if acting as someone else
 void setActions(String[] actions1)
          actions to query, or none to query all actions
 void setAttributeAssignType(String attributeAssignType1)
          is the attribute assign type we are looking for
 void setAttributeDefType(String attributeDefType1)
          null for all, or specify an AttributeDefType e.g.
 void setAttributeDefValueType(String attributeDefValueType1)
          required if sending theValue, can be: floating, integer, memberId, string, timestamp
 void setClientVersion(String clientVersion1)
          is the version of the client.
 void setEnabled(String enabled1)
          A for all, T or null for enabled only, F for disabled
 void setIncludeAssignmentsFromAssignments(String includeAssignmentsFromAssignments1)
          T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well
 void setIncludeAssignmentsOnAssignments(String includeAssignmentsOnAssignments1)
          if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true.
 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 setTheValue(String theValue1)
          value if you are passing in one attributeDefNameLookup
 void setWsAssignAssignOwnerActions(String[] wsAssignAssignOwnerActions1)
          if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to
 void setWsAssignAssignOwnerAttributeAssignLookups(WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups1)
          if looking for assignments on assignments, this is the assignment the assignment is assigned to
 void setWsAssignAssignOwnerAttributeDefLookups(WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups1)
          if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to
 void setWsAssignAssignOwnerAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups1)
          if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to
 void setWsAttributeAssignLookups(WsAttributeAssignLookup[] wsAttributeAssignLookups1)
          if you know the assign ids you want, put them here
 void setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
          find assignments in these attribute defs (optional)
 void setWsAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAttributeDefNameLookups1)
          find assignments in these attribute def names (optional)
 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

WsRestGetAttributeAssignmentsRequest

public WsRestGetAttributeAssignmentsRequest()
Method Detail

getAttributeDefValueType

public String getAttributeDefValueType()
required if sending theValue, can be: floating, integer, memberId, string, timestamp

Returns:
attributeDefValueType

setAttributeDefValueType

public void setAttributeDefValueType(String attributeDefValueType1)
required if sending theValue, can be: floating, integer, memberId, string, timestamp

Parameters:
attributeDefValueType1 -

getAttributeDefType

public String getAttributeDefType()
null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, perm

Returns:
attributeDefValueType

setAttributeDefType

public void setAttributeDefType(String attributeDefType1)
null for all, or specify an AttributeDefType e.g. attr, limit, service, type, limit, perm

Parameters:
attributeDefType1 -

getTheValue

public String getTheValue()
value if you are passing in one attributeDefNameLookup

Returns:
value

setTheValue

public void setTheValue(String theValue1)
value if you are passing in one attributeDefNameLookup

Parameters:
theValue1 -

getIncludeAssignmentsFromAssignments

public String getIncludeAssignmentsFromAssignments()
T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well

Returns:
if include assignments from assignments

setIncludeAssignmentsFromAssignments

public void setIncludeAssignmentsFromAssignments(String includeAssignmentsFromAssignments1)
T|F if you are finding an assignment that is an assignmentOnAssignment, then get the assignment which tells you the owner as well

Parameters:
includeAssignmentsFromAssignments1 -

retrieveRestHttpMethod

public GrouperRestHttpMethod retrieveRestHttpMethod()
Description copied from interface: WsRequestBean
see which http method this is supposed to be associated with, and override whatever was passed in

Specified by:
retrieveRestHttpMethod in interface WsRequestBean
Returns:
the method
See Also:
WsRequestBean.retrieveRestHttpMethod()

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 -

getWsAttributeDefLookups

public WsAttributeDefLookup[] getWsAttributeDefLookups()
find assignments in these attribute defs (optional)

Returns:
defs

setWsAttributeDefLookups

public void setWsAttributeDefLookups(WsAttributeDefLookup[] wsAttributeDefLookups1)
find assignments in these attribute defs (optional)

Parameters:
wsAttributeDefLookups1 -

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 -

getIncludeAssignmentsOnAssignments

public String getIncludeAssignmentsOnAssignments()
if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.

Returns:
if include assignments on assignments

setIncludeAssignmentsOnAssignments

public void setIncludeAssignmentsOnAssignments(String includeAssignmentsOnAssignments1)
if this is not querying assignments on assignments directly, but the assignments and assignments on those assignments should be returned, enter true. default to false.

Parameters:
includeAssignmentsOnAssignments1 -

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 -

getEnabled

public String getEnabled()
A for all, T or null for enabled only, F for disabled

Returns:
enabled

setEnabled

public void setEnabled(String enabled1)
A for all, T or null for enabled only, F for disabled

Parameters:
enabled1 -

getWsAssignAssignOwnerAttributeAssignLookups

public WsAttributeAssignLookup[] getWsAssignAssignOwnerAttributeAssignLookups()
if looking for assignments on assignments, this is the assignment the assignment is assigned to

Returns:
results

setWsAssignAssignOwnerAttributeAssignLookups

public void setWsAssignAssignOwnerAttributeAssignLookups(WsAttributeAssignLookup[] wsAssignAssignOwnerAttributeAssignLookups1)
if looking for assignments on assignments, this is the assignment the assignment is assigned to

Parameters:
wsAssignAssignOwnerAttributeAssignLookups1 -

getWsAssignAssignOwnerAttributeDefLookups

public WsAttributeDefLookup[] getWsAssignAssignOwnerAttributeDefLookups()
if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to

Returns:
results

setWsAssignAssignOwnerAttributeDefLookups

public void setWsAssignAssignOwnerAttributeDefLookups(WsAttributeDefLookup[] wsAssignAssignOwnerAttributeDefLookups1)
if looking for assignments on assignments, this is the attribute definition of the assignment the assignment is assigned to

Parameters:
wsAssignAssignOwnerAttributeDefLookups1 -

getWsAssignAssignOwnerAttributeDefNameLookups

public WsAttributeDefNameLookup[] getWsAssignAssignOwnerAttributeDefNameLookups()
if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to

Returns:
result

setWsAssignAssignOwnerAttributeDefNameLookups

public void setWsAssignAssignOwnerAttributeDefNameLookups(WsAttributeDefNameLookup[] wsAssignAssignOwnerAttributeDefNameLookups1)
if looking for assignments on assignments, this is the attribute def name of the assignment the assignment is assigned to

Parameters:
wsAssignAssignOwnerAttributeDefNameLookups1 -

getWsAssignAssignOwnerActions

public String[] getWsAssignAssignOwnerActions()
if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to

Returns:
actions

setWsAssignAssignOwnerActions

public void setWsAssignAssignOwnerActions(String[] wsAssignAssignOwnerActions1)
if looking for assignments on assignments, this are the actions of the assignment the assignment is assigned to

Parameters:
wsAssignAssignOwnerActions1 -