oracle.webcenter.portal.persistence

Interface DataServiceEntity

All Superinterfaces:

AssetResource, ManagedResource, PortalEntity

All Known Subinterfaces:

RESTDataServiceEntity, SOAPDataServiceEntity, SQLDataServiceEntity

public interface DataServiceEntity
extends AssetResource, ManagedResource

This Interface represents the actual DataServiceEntity that need to be persisted.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.webcenter.portal.persistence.AssetResource

AssetResource.ExcludedFrom

Method Summary

Modifier and Type	Method and Description
void	addToBusinessObjects(BusinessObjectEntity businessObjectEntity)
void	clearBusinessObjects() Clear business objects
java.lang.String	getAuthenticationType()
java.util.List<BusinessObjectEntity>	getBusinessObjects()
java.lang.String	getConnectionName()
java.lang.String	getDCId()
java.lang.String	getDCXPath()
java.lang.String	getDSType() Get the type of the data service
java.lang.String	getExternalAppId()
void	removeFromBusinessObjects(BusinessObjectEntity businessObjectEntity)
void	setAuthenticationType(java.lang.String authenticationType) Authentication type information which will be used during the REST test() functionality Authentication type is applicable only for REST dataservice type
void	setBusinessObjects(java.util.List<BusinessObjectEntity> businessObjects)
void	setConnectionName(java.lang.String connectionName) This connection name will be used by lifecycle during connection fix up.
void	setDCId(java.lang.String dCId) Every data service works on underlying data control.
void	setDCXPath(java.lang.String dCXPath) Data control dcx path need to be persisted , so that life cycle shall be able to load data control informtion.
void	setDSType(java.lang.String type) Type of the data service like SOAP or REST.
void	setExternalAppId(java.lang.String externalAppId) ExternalAppId is used to store the username and password information which will be used during the REST test() functionality ExternalAppId is applicable only for REST dataservice type

Methods inherited from interface oracle.webcenter.portal.persistence.AssetResource

clearCustomAttributes, getCategory, getContentDir, getCustomAttributes, getDescriptionKey, getDisplayNameKey, getExcludedFrom, getExcludedPortalIds, getIconURI, getInputId, getInputVersionId, getLockedBy, getLockedDate, getLogoURL, getResourceBundle, getUsesCustomSecurity, getVisible, putIntoCustomAttributes, removeFromCustomAttributes, setCategory, setContentDir, setCustomAttributes, setDescriptionKey, setDisplayNameKey, setExcludedFrom, setExcludedPortalIds, setIconURI, setInputId, setInputVersionId, setLockedBy, setLockedDate, setLogoURL, setResourceBundle, setUsesCustomSecurity, setVisible

Methods inherited from interface oracle.webcenter.portal.persistence.PortalEntity

getAuthorizedActions, getCreated, getCreator, getDescription, getDocumentRef, getId, getIsInitialized, getIsSecured, getIsSeeded, getModified, getModifier, getName, getNamespace, getPortal, getRootSecurityEntity, getSecurityEntity, getSecurityId, getShortId, getType, getVersionId, inheritsSecurity, lock, setCreated, setCreator, setDescription, setDocumentRef, setIsInitialized, setIsSeeded, setName, setNamespace, setPortal, setSecurityEntity, setSecurityId, setVersionId

Method Detail

getDCId

@PersistProperty(offset=14,
                 type=STRING)
java.lang.String getDCId()

Returns:

- Returns the data control id

setDCId

void setDCId(java.lang.String dCId)

Every data service works on underlying data control. This data control is not exposed to the caller and is internal to data service implementation ( e.g. SOAP data service , REST data service ). Data control id would need to be set by various implementation classes. This id will be used for loading the data control related proeprties and will also be used by lifecycle while import/export of data services.

Parameters:

dCId - - underlying data control id to be set once data control is successfully created

getDCXPath

@PersistProperty(offset=15,
                 type=STRING)
java.lang.String getDCXPath()

Returns:

- DCX path for underlying data control in use.

setDCXPath

void setDCXPath(java.lang.String dCXPath)

Data control dcx path need to be persisted , so that life cycle shall be able to load data control informtion. DCX path is is not exposed to the caller and is internal to data service implementation ( e.g. SOAP data service, REST data service ). DCX path would need to be set by various implementation classes.

Parameters:

dCXPath - - File path where data control definition is stored

getDSType

@PersistProperty(offset=16,
                 type=STRING)
java.lang.String getDSType()

Get the type of the data service

Returns:

setDSType

void setDSType(java.lang.String type)

Type of the data service like SOAP or REST. Type will be used while reconstructing the data service instance upon request

Parameters:

type - - Type of the DataService

getConnectionName

@PersistProperty(offset=17,
                 type=STRING)
java.lang.String getConnectionName()

Returns:

- underlying ADF connection name

setConnectionName

void setConnectionName(java.lang.String connectionName)

This connection name will be used by lifecycle during connection fix up.

Parameters:

connectionName - - underlying ADF connection name

getExternalAppId

@PersistProperty(offset=18,
                 type=STRING)
java.lang.String getExternalAppId()

Returns:

- ExternalAppId information which holds the username and password

setExternalAppId

void setExternalAppId(java.lang.String externalAppId)

ExternalAppId is used to store the username and password information which will be used during the REST test() functionality ExternalAppId is applicable only for REST dataservice type

Parameters:

ExternlAppId -

getAuthenticationType

@PersistProperty(offset=19,
                 type=STRING)
java.lang.String getAuthenticationType()

Returns:

- Authentication type information

setAuthenticationType

void setAuthenticationType(java.lang.String authenticationType)

Authentication type information which will be used during the REST test() functionality Authentication type is applicable only for REST dataservice type

Parameters:

AuthenticationType -

getBusinessObjects

@PersistReference(eager=false,
                  strong=false,
                  export=false)
java.util.List<BusinessObjectEntity> getBusinessObjects()

Returns:

the business object entities associated with this data service

setBusinessObjects

void setBusinessObjects(java.util.List<BusinessObjectEntity> businessObjects)

Parameters:

businessObjects - the business object entities to set

addToBusinessObjects

void addToBusinessObjects(BusinessObjectEntity businessObjectEntity)

Parameters:

businessObjectEntity -

removeFromBusinessObjects

void removeFromBusinessObjects(BusinessObjectEntity businessObjectEntity)

Parameters:

businessObjectEntity -

clearBusinessObjects

void clearBusinessObjects()

Clear business objects