CatalogRequest Interface
- public interface CatalogRequest
This interface is the common input record
to catalog services that return catalog data. It contains
everything required to resolve a catalog request to catalog
content.
-
All Known Implementing Classes
-
CatalogRequestImpl
public static final int |
-
ADMINISTRATION
- Authorization bit-field constant for administrator use of the catalog.
|
public static final int |
-
DEFAULT_USE
- Authorization bit-field constant for end-user use of the catalog.
|
public int |
-
getAuthorization ()
- Gets the authorization bit-field for this catalog request.
|
public String |
-
getLanguage ()
|
public boolean |
-
getShowAll ()
|
public boolean |
-
hasAuthorization (int authorizationCode)
|
public void |
-
setLanguage (String language)
- Sets the language associated with the catalog request or null
if this request (or catalog) is language unaware.
|
public void |
-
setShowAll (boolean showAll)
- Sets the visibility attribute for this catalog request.
|
ADMINISTRATION
public static final int ADMINISTRATION
- Authorization bit-field constant for administrator use of the catalog.
DEFAULT_USE
public static final int DEFAULT_USE
- Authorization bit-field constant for end-user use of the catalog.
getAuthorization() Method
public int getAuthorization()
Gets the authorization bit-field for this catalog request.
getLanguage() Method
public String
getLanguage()
Returns
- the language associated with the catalog request or null
if this request (or catalog) is language unaware.
getShowAll() Method
public boolean getShowAll()
Returns
- whether to retrieve all catalog items, irrespective
of whether they have been marked as invisible.
hasAuthorization(int) Method
public boolean hasAuthorization(int authorizationCode)
Returns
- true if the current catalog request has the required authorization:
one of DEFAULT_USE or ADMINISTRATION.
setLanguage(String) Method
public void setLanguage(String
language)
Sets the language associated with the catalog request or null
if this request (or catalog) is language unaware.
Parameters
-
language
- the language attribute to use.
setShowAll(boolean) Method
public void setShowAll(boolean showAll)
Sets the visibility attribute for this catalog request.
if the showAll attribute is true all items will be returned
irrespective of item visiblity. By default end-user
catalog requests have showAll set to false and administrator
catalog requests have showAll set to true.
return the showAll attribute