edu.internet2.middleware.grouper.ws.coresoap
Class WsAttributeDefNameLookup

java.lang.Object
  extended by edu.internet2.middleware.grouper.ws.coresoap.WsAttributeDefNameLookup
All Implemented Interfaces:
GrouperWsToStringCompact

public class WsAttributeDefNameLookup
extends java.lang.Object
implements GrouperWsToStringCompact

 Class to lookup an attribute def name via web service
 
 developers make sure each setter calls this.clearAttributeDefName();
 

Author:
mchyzer

Nested Class Summary
static class WsAttributeDefNameLookup.AttributeDefNameFindResult
          result of attribute def name find
 
Constructor Summary
WsAttributeDefNameLookup()
           
WsAttributeDefNameLookup(java.lang.String attributeDefNameName1, java.lang.String uuid1)
           
WsAttributeDefNameLookup(java.lang.String attributeDefNameName1, java.lang.String uuid1, java.lang.String idIndex1)
           
 
Method Summary
 boolean blank()
          see if blank
static java.util.Set<java.lang.String> convertToAttributeDefNameIds(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, java.lang.StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo)
          convert attributeDefName lookups to attributeDefName ids
static java.util.Set<java.lang.String> convertToAttributeDefNameIds(GrouperSession grouperSession, WsAttributeDefNameLookup[] wsAttributeDefNameLookups, java.lang.StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo, int[] lookupCount)
          convert attributeDefName lookups to attributeDefName ids
static WsAttributeDefNameLookup createIfNeeded(java.lang.String uuid, java.lang.String name)
          create if any not null, otherwise null
 java.lang.String getIdIndex()
          integer ID for object
 java.lang.String getName()
          name of the attributeDefName to find (includes stems, e.g.
 java.lang.String getUuid()
          uuid of the attributeDefName to find
 boolean hasData()
          see if this attributeDefName lookup has data
 AttributeDefName retrieveAttributeDefName()
           Note: this is not a javabean property because we dont want it in the web service
 WsAttributeDefNameLookup.AttributeDefNameFindResult retrieveAttributeDefNameFindResult()
           Note: this is not a javabean property because we dont want it in the web service
 void retrieveAttributeDefNameIfNeeded(GrouperSession grouperSession)
          retrieve the attributeDefName for this lookup if not looked up yet.
 AttributeDefName retrieveAttributeDefNameIfNeeded(GrouperSession grouperSession, java.lang.String invalidQueryReason)
          retrieve the attributeDefName for this lookup if not looked up yet.
 java.util.Set<PITAttributeDefName> retrievePITAttributeDefNames()
           Note: this is not a javabean property because we dont want it in the web service
 java.util.Set<PITAttributeDefName> retrievePITAttributeDefNamesIfNeeded(java.lang.String invalidQueryReason, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo)
          retrieve the pit attribute def names for this lookup if not looked up yet.
 void setIdIndex(java.lang.String idIndex1)
          integer ID for object
 void setName(java.lang.String theName)
          name of the attributeDefName to find (includes stems, e.g.
 void setUuid(java.lang.String uuid1)
          uuid of the attributeDefName to find
 java.lang.String toString()
          make sure this is an explicit toString
 java.lang.String toStringCompact()
          make sure this is an explicit toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsAttributeDefNameLookup

public WsAttributeDefNameLookup()

WsAttributeDefNameLookup

public WsAttributeDefNameLookup(java.lang.String attributeDefNameName1,
                                java.lang.String uuid1)
Parameters:
attributeDefNameName1 -
uuid1 -

WsAttributeDefNameLookup

public WsAttributeDefNameLookup(java.lang.String attributeDefNameName1,
                                java.lang.String uuid1,
                                java.lang.String idIndex1)
Parameters:
attributeDefNameName1 -
uuid1 -
idIndex1 -
Method Detail

createIfNeeded

public static WsAttributeDefNameLookup createIfNeeded(java.lang.String uuid,
                                                      java.lang.String name)
create if any not null, otherwise null

Parameters:
uuid -
name -
Returns:
the lookup

getIdIndex

public java.lang.String getIdIndex()
integer ID for object

Returns:
the id

setIdIndex

public void setIdIndex(java.lang.String idIndex1)
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

public AttributeDefName retrieveAttributeDefName()
 
 Note: this is not a javabean property because we dont want it in the web service
 

Returns:
the attributeDefName

retrievePITAttributeDefNames

public java.util.Set<PITAttributeDefName> retrievePITAttributeDefNames()
 
 Note: this is not a javabean property because we dont want it in the web service
 

Returns:
the pit attributeDefs

retrieveAttributeDefNameFindResult

public WsAttributeDefNameLookup.AttributeDefNameFindResult 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

public java.lang.String toString()
make sure this is an explicit toString

Overrides:
toString in class java.lang.Object

retrieveAttributeDefNameIfNeeded

public void retrieveAttributeDefNameIfNeeded(GrouperSession grouperSession)
retrieve the attributeDefName for this lookup if not looked up yet. pass in a grouper session

Parameters:
grouperSession -

retrieveAttributeDefNameIfNeeded

public AttributeDefName retrieveAttributeDefNameIfNeeded(GrouperSession grouperSession,
                                                         java.lang.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 java.util.Set<PITAttributeDefName> retrievePITAttributeDefNamesIfNeeded(java.lang.String invalidQueryReason,
                                                                               java.sql.Timestamp pointInTimeFrom,
                                                                               java.sql.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 WsInvalidQueryException
pointInTimeFrom -
pointInTimeTo -
Returns:
the pit attribute def name
Throws:
WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

getUuid

public java.lang.String getUuid()
uuid of the attributeDefName to find

Returns:
the uuid

setUuid

public void setUuid(java.lang.String uuid1)
uuid of the attributeDefName to find

Parameters:
uuid1 - the uuid to set

getName

public java.lang.String getName()
name of the attributeDefName to find (includes stems, e.g. stem1:stem2:attributeDefNameName

Returns:
the theName

setName

public void setName(java.lang.String theName)
name of the attributeDefName to find (includes stems, e.g. stem1:stem2:attributeDefNameName

Parameters:
theName - the theName to set

convertToAttributeDefNameIds

public static java.util.Set<java.lang.String> convertToAttributeDefNameIds(GrouperSession grouperSession,
                                                                           WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
                                                                           java.lang.StringBuilder errorMessage,
                                                                           AttributeDefType attributeDefType,
                                                                           boolean usePIT,
                                                                           java.sql.Timestamp pointInTimeFrom,
                                                                           java.sql.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 java.util.Set<java.lang.String> convertToAttributeDefNameIds(GrouperSession grouperSession,
                                                                           WsAttributeDefNameLookup[] wsAttributeDefNameLookups,
                                                                           java.lang.StringBuilder errorMessage,
                                                                           AttributeDefType attributeDefType,
                                                                           boolean usePIT,
                                                                           java.sql.Timestamp pointInTimeFrom,
                                                                           java.sql.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

public java.lang.String toStringCompact()
make sure this is an explicit toString

Specified by:
toStringCompact in interface GrouperWsToStringCompact
Returns:
return a compact to string