com.ibm.portal.resolver.data
Interface StatusCodeDataSource

All Superinterfaces:

Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped

All Known Implementing Classes:

AbstractDataSource

public interface StatusCodeDataSource
extends DataSource

Optional interface implemented by a DataSource to specify a suggested status code.

Since:

6.1.0.1

Note:

This interface is designed to be implemented by clients.

Field Summary

static int

SC_UNDEFINED Special status code that indicates that the data source does not want to specify the status code but relies on the default computation.

Fields inherited from interface com.ibm.portal.resolver.data.DataSource

CONTENT_TYPE_UNKNOWN, CREATION_UNKNOWN, EXPIRATION_UNKNOWN, LAST_MODIFICATION_UNKNOWN, MAX_AGE_INFINITE, MAX_AGE_NONE, ROOT_DATE

Fields inherited from interface com.ibm.portal.resolver.data.Addressable

EMPTY_PARAMETERS

Method Summary

int	getStatus() Returns a suggested HTTP status code.

Methods inherited from interface com.ibm.portal.resolver.data.DataSource

getContentType, getCreated, getExpiration, getLastModified

Methods inherited from interface com.ibm.portal.resolver.data.Addressable

getParameters, getURI

Methods inherited from interface com.ibm.portal.Disposable

dispose

Field Detail

SC_UNDEFINED

static final int SC_UNDEFINED

Special status code that indicates that the data source does not want to specify the status code but relies on the default computation.

Since:

6.1.0.2

See Also:

Constant Field Values

Method Detail

getStatus

int getStatus()

Returns a suggested HTTP status code. It is up to the framework to decide if this suggested status code is respected.

Returns:

a status code, may return SC_UNDEFINED to indicate that the status code should not be overridden