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

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

public class WsAttributeDefLookup
extends java.lang.Object
implements GrouperWsToStringCompact

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

Author:
mchyzer

Nested Class Summary
static class WsAttributeDefLookup.AttributeDefFindResult
          result of attribute def name find
 
Constructor Summary
WsAttributeDefLookup()
           
WsAttributeDefLookup(java.lang.String name1, java.lang.String uuid1)
           
WsAttributeDefLookup(java.lang.String name1, java.lang.String uuid1, java.lang.String idIndex1)
           
 
Method Summary
 boolean blank()
          see if blank
static java.util.Set<java.lang.String> convertToAttributeDefIds(GrouperSession grouperSession, WsAttributeDefLookup[] wsAttributeDefLookups, java.lang.StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo)
          convert attributeDef lookups to attributeDef ids
static java.util.Set<java.lang.String> convertToAttributeDefIds(GrouperSession grouperSession, WsAttributeDefLookup[] wsAttributeDefLookups, java.lang.StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo, int[] lookupCount)
          convert attributeDef lookups to attributeDef ids
 java.lang.String getIdIndex()
          integer ID for object
 java.lang.String getName()
          name of the attributeDef to find (includes stems, e.g.
 java.lang.String getUuid()
          uuid of the attributeDef to find
 boolean hasData()
          see if this attributeDef lookup has data
 AttributeDef retrieveAttributeDef()
           Note: this is not a javabean property because we dont want it in the web service
 WsAttributeDefLookup.AttributeDefFindResult retrieveAttributeDefFindResult()
           Note: this is not a javabean property because we dont want it in the web service
 void retrieveAttributeDefIfNeeded(GrouperSession grouperSession)
          retrieve the attributeDef for this lookup if not looked up yet.
 AttributeDef retrieveAttributeDefIfNeeded(GrouperSession grouperSession, java.lang.String invalidQueryReason)
          retrieve the attributeDef for this lookup if not looked up yet.
 java.util.Set<PITAttributeDef> retrievePITAttributeDefs()
           Note: this is not a javabean property because we dont want it in the web service
 java.util.Set<PITAttributeDef> retrievePITAttributeDefsIfNeeded(java.lang.String invalidQueryReason, java.sql.Timestamp pointInTimeFrom, java.sql.Timestamp pointInTimeTo)
          retrieve the pit attribute defs 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 attributeDef to find (includes stems, e.g.
 void setUuid(java.lang.String uuid1)
          uuid of the attributeDef 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

WsAttributeDefLookup

public WsAttributeDefLookup()

WsAttributeDefLookup

public WsAttributeDefLookup(java.lang.String name1,
                            java.lang.String uuid1)
Parameters:
name1 -
uuid1 -

WsAttributeDefLookup

public WsAttributeDefLookup(java.lang.String name1,
                            java.lang.String uuid1,
                            java.lang.String idIndex1)
Parameters:
name1 -
uuid1 -
idIndex1 -
Method Detail

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 attributeDef lookup has data

Returns:
true if it has data

retrieveAttributeDef

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

Returns:
the attributeDef

retrievePITAttributeDefs

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

Returns:
the pit attributeDefs

retrieveAttributeDefFindResult

public WsAttributeDefLookup.AttributeDefFindResult retrieveAttributeDefFindResult()
 
 Note: this is not a javabean property because we dont want it in the web service
 

Returns:
the attributeDefFindResult, this is never null

toString

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

Overrides:
toString in class java.lang.Object

retrieveAttributeDefIfNeeded

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

Parameters:
grouperSession -

retrieveAttributeDefIfNeeded

public AttributeDef retrieveAttributeDefIfNeeded(GrouperSession grouperSession,
                                                 java.lang.String invalidQueryReason)
                                          throws WsInvalidQueryException
retrieve the attributeDef 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 attributeDef
Throws:
WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

retrievePITAttributeDefsIfNeeded

public java.util.Set<PITAttributeDef> retrievePITAttributeDefsIfNeeded(java.lang.String invalidQueryReason,
                                                                       java.sql.Timestamp pointInTimeFrom,
                                                                       java.sql.Timestamp pointInTimeTo)
                                                                throws WsInvalidQueryException
retrieve the pit attribute defs 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
Throws:
WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

getUuid

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

Returns:
the uuid

setUuid

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

Parameters:
uuid1 - the uuid to set

getName

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

Returns:
the theName

setName

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

Parameters:
theName - the theName to set

convertToAttributeDefIds

public static java.util.Set<java.lang.String> convertToAttributeDefIds(GrouperSession grouperSession,
                                                                       WsAttributeDefLookup[] wsAttributeDefLookups,
                                                                       java.lang.StringBuilder errorMessage,
                                                                       AttributeDefType attributeDefType,
                                                                       boolean usePIT,
                                                                       java.sql.Timestamp pointInTimeFrom,
                                                                       java.sql.Timestamp pointInTimeTo)
convert attributeDef lookups to attributeDef ids

Parameters:
grouperSession -
wsAttributeDefLookups -
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

convertToAttributeDefIds

public static java.util.Set<java.lang.String> convertToAttributeDefIds(GrouperSession grouperSession,
                                                                       WsAttributeDefLookup[] wsAttributeDefLookups,
                                                                       java.lang.StringBuilder errorMessage,
                                                                       AttributeDefType attributeDefType,
                                                                       boolean usePIT,
                                                                       java.sql.Timestamp pointInTimeFrom,
                                                                       java.sql.Timestamp pointInTimeTo,
                                                                       int[] lookupCount)
convert attributeDef lookups to attributeDef ids

Parameters:
grouperSession -
wsAttributeDefLookups -
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

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