com.ibm.commerce.giftcenter.facade.datatypes

Interface GiftListAccessSpecifierType

public interface GiftListAccessSpecifierType

A representation of the model object 'Gift List Access Specifier Type'.

The following features are supported:

• Access Specifier
• Manage Access Password
• Guest Access Password
• Guest Access Key
• Registry Access Key
• User Data

See Also:

GiftCenterPackage.getGiftListAccessSpecifierType()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessSpecifier() Returns the value of the 'Access Specifier' attribute.
java.lang.String	getGuestAccessKey() Returns the value of the 'Guest Access Key' attribute.
java.lang.String	getGuestAccessPassword() Returns the value of the 'Guest Access Password' attribute.
java.lang.String	getManageAccessPassword() Returns the value of the 'Manage Access Password' attribute.
java.lang.String	getRegistryAccessKey() Returns the value of the 'Registry Access Key' attribute.
UserDataType	getUserData() Returns the value of the 'User Data' containment reference.
void	setAccessSpecifier(java.lang.String value) Sets the value of the 'Access Specifier' attribute.
void	setGuestAccessKey(java.lang.String value) Sets the value of the 'Guest Access Key' attribute.
void	setGuestAccessPassword(java.lang.String value) Sets the value of the 'Guest Access Password' attribute.
void	setManageAccessPassword(java.lang.String value) Sets the value of the 'Manage Access Password' attribute.
void	setRegistryAccessKey(java.lang.String value) Sets the value of the 'Registry Access Key' attribute.
void	setUserData(UserDataType value) Sets the value of the 'User Data' containment reference.

Method Detail

getAccessSpecifier

java.lang.String getAccessSpecifier()

Returns the value of the 'Access Specifier' attribute. The search restriction that is to be imposed on the wish list. Public - can be searched and viewed by anyone; Private - cannot be searched and is not password protected; Protected - can be searched, but would require a password to view.

Returns:

the value of the 'Access Specifier' attribute.

See Also:

setAccessSpecifier(String), GiftCenterPackage.getGiftListAccessSpecifierType_AccessSpecifier()

setAccessSpecifier

void setAccessSpecifier(java.lang.String value)

Sets the value of the 'Access Specifier' attribute.

Parameters:

value - the new value of the 'Access Specifier' attribute.

See Also:

getAccessSpecifier()

getManageAccessPassword

java.lang.String getManageAccessPassword()

Returns the value of the 'Manage Access Password' attribute. The password registrants use to manage the gift list.

Returns:

the value of the 'Manage Access Password' attribute.

See Also:

setManageAccessPassword(String), GiftCenterPackage.getGiftListAccessSpecifierType_ManageAccessPassword()

setManageAccessPassword

void setManageAccessPassword(java.lang.String value)

Sets the value of the 'Manage Access Password' attribute.

Parameters:

value - the new value of the 'Manage Access Password' attribute.

See Also:

getManageAccessPassword()

getGuestAccessPassword

java.lang.String getGuestAccessPassword()

Returns the value of the 'Guest Access Password' attribute. The password guests use to view a password-protected registry.

Returns:

the value of the 'Guest Access Password' attribute.

See Also:

setGuestAccessPassword(String), GiftCenterPackage.getGiftListAccessSpecifierType_GuestAccessPassword()

setGuestAccessPassword

void setGuestAccessPassword(java.lang.String value)

Sets the value of the 'Guest Access Password' attribute.

Parameters:

value - the new value of the 'Guest Access Password' attribute.

See Also:

getGuestAccessPassword()

getGuestAccessKey

java.lang.String getGuestAccessKey()

Returns the value of the 'Guest Access Key' attribute. A unique key that provides guests with direct access to the gift registry, bypassing the requirement to enter guest access password.

Returns:

the value of the 'Guest Access Key' attribute.

See Also:

setGuestAccessKey(String), GiftCenterPackage.getGiftListAccessSpecifierType_GuestAccessKey()

setGuestAccessKey

void setGuestAccessKey(java.lang.String value)

Sets the value of the 'Guest Access Key' attribute.

Parameters:

value - the new value of the 'Guest Access Key' attribute.

See Also:

getGuestAccessKey()

getRegistryAccessKey

java.lang.String getRegistryAccessKey()

Returns the value of the 'Registry Access Key' attribute. The unique key that allows a registrant to add items into the registry directly by bypassing the manage access password.

Returns:

the value of the 'Registry Access Key' attribute.

See Also:

setRegistryAccessKey(String), GiftCenterPackage.getGiftListAccessSpecifierType_RegistryAccessKey()

setRegistryAccessKey

void setRegistryAccessKey(java.lang.String value)

Sets the value of the 'Registry Access Key' attribute.

Parameters:

value - the new value of the 'Registry Access Key' attribute.

See Also:

getRegistryAccessKey()

getUserData

UserDataType getUserData()

Returns the value of the 'User Data' containment reference.

If the meaning of the 'User Data' containment reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'User Data' containment reference.

See Also:

setUserData(UserDataType), GiftCenterPackage.getGiftListAccessSpecifierType_UserData()

setUserData

void setUserData(UserDataType value)

Sets the value of the 'User Data' containment reference.

Parameters:

value - the new value of the 'User Data' containment reference.

See Also:

getUserData()