GiftRegistryAuthenticationVO

java.lang.Object
- com.ibm.commerce.giftregistry.service.valueobjects.BaseVO
- - com.ibm.commerce.giftregistry.service.valueobjects.GiftRegistryAuthenticationVO

All Implemented Interfaces:

java.io.Serializable
```
public class GiftRegistryAuthenticationVO
extends BaseVO
```
The GiftRegistryAuthenticationVO is used for authentication purposes

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`GIFT_REGISTRY_AUTHENTICATION_EXTERNAL_GIFT_REGISTRY_ID` External gift registry ID
`static java.lang.String`	`GIFT_REGISTRY_AUTHENTICATION_PASSWORD` Registry password
`static java.lang.String`	`GIFT_REGISTRY_GIFTREGISTRY_ID` Gift registry ID
`static java.lang.String`	`GIFT_REGISTRY_GUEST_ACCESS_KEY` Guest access key
`static java.lang.String`	`GIFT_REGISTRY_REG_ACCESS_KEY` Registrant access key
`static java.lang.String`	`GIFT_REGISTRY_REGISTRANT_TYPE` Registrant type

Fields inherited from class com.ibm.commerce.giftregistry.service.valueobjects.BaseVO
CLASS_NAME, VALUE_OBJECT_ID

Constructor Summary

Constructors
Constructor and Description

GiftRegistryAuthenticationVO()

Constructors
Constructor and Description
`GiftRegistryAuthenticationVO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Integer[]`	`getAuthenticateTypes()` Returns the specific registrant types used for authentication
`java.lang.String`	`getExternalGiftRegistryId()` Returns the `externalId`
`java.lang.Long`	`getGiftRegistryId()` Returns the gift registry ID
`java.lang.String`	`getGuestAccessKey()` Returns the guest access key
`java.lang.Object`	`getId()` Returns a unique key to identify this value object
`java.lang.String`	`getPassword()` Returns the password
`java.lang.String`	`getRegAccessKey()` Returns the registrant access key
`void`	`setAuthenticateForRegistrantType(java.lang.Boolean registrant)` Sets to true if authentication should be done for only this type
`void`	`setAuthenticateTypes(java.lang.Integer[] types)` Sets the specific registrant types used to for authentication.
`void`	`setExternalGiftRegistryId(java.lang.String externalId)` Sets the `externalId`
`void`	`setGiftRegistryId(java.lang.Long grId)` Set the gift registry ID
`void`	`setGuestAccessKey(java.lang.String guestAccessKey)` Set the guest access key
`void`	`setPassword(java.lang.String password)` Sets the password
`void`	`setRegAccessKey(java.lang.String regAccessKey)` Set the registrant access key

Methods inherited from class com.ibm.commerce.giftregistry.service.valueobjects.BaseVO
equals, get, getContext, getDataMap, getDescriptor, getObjectKey, hashCode, isEmpty, isNew, set, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_AUTHENTICATION_EXTERNAL_GIFT_REGISTRY_ID
```
public static final java.lang.String GIFT_REGISTRY_AUTHENTICATION_EXTERNAL_GIFT_REGISTRY_ID
```
    External gift registry ID
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_AUTHENTICATION_PASSWORD
```
public static final java.lang.String GIFT_REGISTRY_AUTHENTICATION_PASSWORD
```
    Registry password
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_REGISTRANT_TYPE
```
public static final java.lang.String GIFT_REGISTRY_REGISTRANT_TYPE
```
    Registrant type
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_GUEST_ACCESS_KEY
```
public static final java.lang.String GIFT_REGISTRY_GUEST_ACCESS_KEY
```
    Guest access key
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_REG_ACCESS_KEY
```
public static final java.lang.String GIFT_REGISTRY_REG_ACCESS_KEY
```
    Registrant access key
    
    See Also:
    
    Constant Field Values
  - GIFT_REGISTRY_GIFTREGISTRY_ID
```
public static final java.lang.String GIFT_REGISTRY_GIFTREGISTRY_ID
```
    Gift registry ID
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GiftRegistryAuthenticationVO
```
public GiftRegistryAuthenticationVO()
```
- Method Detail
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Sets the password
    
    Parameters:
    
    password -
  - setExternalGiftRegistryId
```
public void setExternalGiftRegistryId(java.lang.String externalId)
```
    Sets the externalId
    
    Parameters:
    
    externalId -
  - setAuthenticateForRegistrantType
```
public void setAuthenticateForRegistrantType(java.lang.Boolean registrant)
```
    Sets to true if authentication should be done for only this type
    
    Parameters:
    
    registrant -
  - setAuthenticateTypes
```
public void setAuthenticateTypes(java.lang.Integer[] types)
```
    Sets the specific registrant types used to for authentication. If a type is set, credential checking will be done on the specified types
    
    Parameters:
    
    types[] -
  - getAuthenticateTypes
```
public java.lang.Integer[] getAuthenticateTypes()
```
    Returns the specific registrant types used for authentication
    
    Returns:
    
    types[]
  - setGuestAccessKey
```
public void setGuestAccessKey(java.lang.String guestAccessKey)
```
    Set the guest access key
    
    Parameters:
    
    guestAccessKey -
  - getGuestAccessKey
```
public java.lang.String getGuestAccessKey()
```
    Returns the guest access key
    
    Returns:
    
    guestAccessKey
  - setRegAccessKey
```
public void setRegAccessKey(java.lang.String regAccessKey)
```
    Set the registrant access key
    
    Parameters:
    
    guestAccessKey -
  - getRegAccessKey
```
public java.lang.String getRegAccessKey()
```
    Returns the registrant access key
    
    Returns:
    
    guestAccessKey
  - getExternalGiftRegistryId
```
public java.lang.String getExternalGiftRegistryId()
```
    Returns the externalId
    
    Returns:
    
    externalId
  - getPassword
```
public java.lang.String getPassword()
```
    Returns the password
    
    Returns:
    
    password
  - getId
```
public java.lang.Object getId()
```
    Returns a unique key to identify this value object
    
    Specified by:
    
    getId in class BaseVO
    
    Returns:
    
    uniqueKey
  - getGiftRegistryId
```
public java.lang.Long getGiftRegistryId()
```
    Returns the gift registry ID
    
    Returns:
    
    giftRegistryId
  - setGiftRegistryId
```
public void setGiftRegistryId(java.lang.Long grId)
```
    Set the gift registry ID
    
    Parameters:
    
    gift - registry ID

Fields inherited from class com.ibm.commerce.giftregistry.service.valueobjects.BaseVO

Methods inherited from class com.ibm.commerce.giftregistry.service.valueobjects.BaseVO

Methods inherited from class java.lang.Object

COPYRIGHT

GIFT_REGISTRY_AUTHENTICATION_EXTERNAL_GIFT_REGISTRY_ID

GIFT_REGISTRY_AUTHENTICATION_PASSWORD

GIFT_REGISTRY_REGISTRANT_TYPE

GIFT_REGISTRY_GUEST_ACCESS_KEY

GIFT_REGISTRY_REG_ACCESS_KEY

GIFT_REGISTRY_GIFTREGISTRY_ID

GiftRegistryAuthenticationVO

setPassword

setExternalGiftRegistryId

setAuthenticateForRegistrantType

setAuthenticateTypes

getAuthenticateTypes

setGuestAccessKey

getGuestAccessKey

setRegAccessKey

getRegAccessKey

getExternalGiftRegistryId

getPassword

getId

getGiftRegistryId

setGiftRegistryId