Class WsAttributeDefNameLookup
java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsAttributeDefNameLookup
- All Implemented Interfaces:
GrouperWsToStringCompact
Class to lookup an attribute def name via web service developers make sure each setter calls this.clearAttributeDefName();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
result of attribute def name find -
Constructor Summary
ConstructorDescriptionWsAttributeDefNameLookup
(String attributeDefNameName1, String uuid1) WsAttributeDefNameLookup
(String attributeDefNameName1, String uuid1, String idIndex1) -
Method Summary
Modifier and TypeMethodDescriptionboolean
blank()
see if blankconvertToAttributeDefNameIds
(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) convert attributeDefName lookups to attributeDefName idsconvertToAttributeDefNameIds
(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, int[] lookupCount) convert attributeDefName lookups to attributeDefName idsstatic WsAttributeDefNameLookup
createIfNeeded
(String uuid, String name) create if any not null, otherwise nullinteger ID for objectgetName()
name of the attributeDefName to find (includes stems, e.g.getUuid()
uuid of the attributeDefName to findboolean
hasData()
see if this attributeDefName lookup has dataNote: this is not a javabean property because we dont want it in the web serviceNote: this is not a javabean property because we dont want it in the web servicevoid
retrieveAttributeDefNameIfNeeded
(GrouperSession grouperSession) retrieve the attributeDefName for this lookup if not looked up yet.retrieveAttributeDefNameIfNeeded
(GrouperSession grouperSession, String invalidQueryReason) retrieve the attributeDefName for this lookup if not looked up yet.Note: this is not a javabean property because we dont want it in the web serviceretrievePITAttributeDefNamesIfNeeded
(String invalidQueryReason, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) retrieve the pit attribute def names for this lookup if not looked up yet.void
setIdIndex
(String idIndex1) integer ID for objectvoid
name of the attributeDefName to find (includes stems, e.g.void
uuid of the attributeDefName to findtoString()
make sure this is an explicit toStringmake sure this is an explicit toString
-
Constructor Details
-
WsAttributeDefNameLookup
public WsAttributeDefNameLookup() -
WsAttributeDefNameLookup
- Parameters:
attributeDefNameName1
-uuid1
-
-
WsAttributeDefNameLookup
- Parameters:
attributeDefNameName1
-uuid1
-idIndex1
-
-
-
Method Details
-
createIfNeeded
create if any not null, otherwise null- Parameters:
uuid
-name
-- Returns:
- the lookup
-
getIdIndex
integer ID for object- Returns:
- the id
-
setIdIndex
integer ID for object- Parameters:
idIndex1
-
-
blank
public boolean blank()see if blank- Returns:
- true if blank
-
hasData
public boolean hasData()see if this attributeDefName lookup has data- Returns:
- true if it has data
-
retrieveAttributeDefName
Note: this is not a javabean property because we dont want it in the web service
- Returns:
- the attributeDefName
-
retrievePITAttributeDefNames
Note: this is not a javabean property because we dont want it in the web service
- Returns:
- the pit attributeDefs
-
retrieveAttributeDefNameFindResult
Note: this is not a javabean property because we dont want it in the web service
- Returns:
- the attributeDefNameFindResult, this is never null
-
toString
make sure this is an explicit toString -
retrieveAttributeDefNameIfNeeded
retrieve the attributeDefName for this lookup if not looked up yet. pass in a grouper session- Parameters:
grouperSession
-
-
retrieveAttributeDefNameIfNeeded
public AttributeDefName retrieveAttributeDefNameIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException retrieve the attributeDefName for this lookup if not looked up yet. pass in a grouper session- Parameters:
grouperSession
-invalidQueryReason
- is the text to go in the WsInvalidQueryException- Returns:
- the attributeDefName
- Throws:
WsInvalidQueryException
- if there is a problem, and if the invalidQueryReason is set
-
retrievePITAttributeDefNamesIfNeeded
public Set<PITAttributeDefName> retrievePITAttributeDefNamesIfNeeded(String invalidQueryReason, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) throws WsInvalidQueryException retrieve the pit attribute def names for this lookup if not looked up yet.- Parameters:
invalidQueryReason
- is the text to go in the WsInvalidQueryExceptionpointInTimeFrom
-pointInTimeTo
-- Returns:
- the pit attribute def name
- Throws:
WsInvalidQueryException
- if there is a problem, and if the invalidQueryReason is set
-
getUuid
uuid of the attributeDefName to find- Returns:
- the uuid
-
setUuid
uuid of the attributeDefName to find- Parameters:
uuid1
- the uuid to set
-
getName
name of the attributeDefName to find (includes stems, e.g. stem1:stem2:attributeDefNameName- Returns:
- the theName
-
setName
name of the attributeDefName to find (includes stems, e.g. stem1:stem2:attributeDefNameName- Parameters:
theName
- the theName to set
-
convertToAttributeDefNameIds
public static Set<String> convertToAttributeDefNameIds(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) convert attributeDefName lookups to attributeDefName ids- Parameters:
grouperSession
-wsAttributeDefNameLookups
-errorMessage
-attributeDefType
-usePIT
-pointInTimeFrom
-pointInTimeTo
-lookupCount
- is an array of size one int where 1 will be added if there are records, and no change if not- Returns:
- the attributeDef ids
-
convertToAttributeDefNameIds
public static Set<String> convertToAttributeDefNameIds(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, int[] lookupCount) convert attributeDefName lookups to attributeDefName ids- Parameters:
grouperSession
-wsAttributeDefNameLookups
-errorMessage
-attributeDefType
-usePIT
-pointInTimeFrom
-pointInTimeTo
-lookupCount
- is an array of size one int where 1 will be added if there are records, and no change if not- Returns:
- the attributeDefName ids
-
toStringCompact
make sure this is an explicit toString- Specified by:
toStringCompact
in interfaceGrouperWsToStringCompact
- Returns:
- return a compact to string
-