com.sapportals.wcm.repository.service.layout

Interface ILayoutService

All Superinterfaces:

IRepositoryService, com.sapportals.wcm.IWcmConst

public interface ILayoutService
extends IRepositoryService, com.sapportals.wcm.IWcmConst

Nested Class Summary

Nested classes/interfaces inherited from interface com.sapportals.wcm.IWcmConst

com.sapportals.wcm.IWcmConst.RESOURCE_TYPE_NAMESPACE, com.sapportals.wcm.IWcmConst.RESOURCE_TYPES

Field Summary

static int

MAX_CONTEXT_LENGTH

Fields inherited from interface com.sapportals.wcm.IWcmConst

ACCESSSTATISTIC_SERVICE, ACL_SERVICE, APP_PROPERTIES_SERVICE, ARCHIVING_PROPERTY_SERVICE, ATTACHMENT_SERVICE, CACHE_MAX_DOCUMENT_AGE, CACHE_MAX_LOOKUP_TIME_MS, CACHE_ONLY_IF_CACHED, COMMENT_SERVICE, COMMENT_SERVLET_PARAM_DESCRIPTION_URI, COMMENT_SERVLET_PARAMETER_STARTPAGE, COMMENT_SERVLET_PARAMETER_XMLFILE, CONTENT_LINK_PORTAL_NAVIGATION, CONTENT_LINK_PREFIX_NAVIGATION, CONTENT_LINK_PREFIX_RID, CONTENT_LINK_PREFIX_ROOM, CONTROLS_INSTRUCTION_NONE, CONTROLS_INSTRUCTION_SUMMARY, DISCUSSION_EXTENSION, DISCUSSION_SERVICE, EVENTLOG_SERVICE, EXTERNAL_PARAMETERS, FEEDBACK_SERVICE, FEEDBACK_SERVLET_PARAM_DESCRIPTION_URI, FEEDBACK_SERVLET_PARAMETER_STARTPAGE, FEEDBACK_SERVLET_PARAMETER_XMLFILE, HTTP_SERVLET_REQUEST, INDEX_TAXONOMY_BROWSER_STARTPAGE, INSTANCE_TYPE_ID, INSTANCE_TYPE_MULTI, INSTANCE_TYPE_SINGLETON, LAYOUT_SERVICE, NAMESPACE_SEPARATOR, PERSONALNOTE_SERVICE, PRIMARY_LOCALE, PROP_ADD_METATAG_NAME_EP60PRINCIPAL, PROP_ATTACHMENT, PROP_CATEGORIES, PROP_COLLECTION, PROP_COMMENT_COUNT, PROP_CONTENT_LANGUAGE, PROP_CONTENTLENGTH, PROP_CONTENTLINK, PROP_CONTENTTYPE, PROP_CREATEDBY, PROP_CREATIONDATE, PROP_DEF_ATTR_APPLICATION, PROP_DESCRIPTION, PROP_DISCUSSION_COUNT, PROP_DISCUSSION_TOPICS_COUNT, PROP_DISPLAYNAME, PROP_DOC_ABSTRACT, PROP_EMBEDDED_KEYWORDS, PROP_EMBEDDED_LINKS, PROP_ENHANCED_COLLECTION, PROP_ETAG, PROP_EXTENSION, PROP_EXTERNALLINK, PROP_FEEDBACK_COUNT, PROP_FOLLOW_LINKS, PROP_HIDDEN, PROP_HIGHLIGHTED_CONTENTLINK, PROP_INDEX_CONTENT, PROP_INDEXING_PROPERTIES, PROP_IS_SYSTEM, PROP_LASTMODIFIED, PROP_LASTMODIFIEDBY, PROP_LASTREADDATE, PROP_LINKTYPE, PROP_PERSNOTE_COUNT, PROP_RANK_VALUE, PROP_RATING, PROP_RATING_AMOUNT_RATING, PROP_RATING_AMOUNT_USER, PROP_RATING_USER, PROP_READBYME, PROP_READONLY, PROP_RESOURCE_TYPE, PROP_RESTRICTED_LINKS, PROP_VERSIONED, PROPERTIES_SERVLET_PARAMETER_RESOURCE, PROPERTIES_SERVLET_PARAMETER_STARTPAGE, PROPERTIES_SERVLET_PARAMETER_XML_FILE, PROPERTIES_SERVLET_VALUE_XML_FILE, PROPERTY_CONFIG_SERVICE, PROPERTY_CONSUMER_ID, RATING_SERVICE, REQUEST_URI, RESOURCE_CONTEXT, RESOURCE_TYPE_PORTAL_PAGE, SAP_NAMESPACE_ROOMSTRUCTURE, SAP_WCM_NAMESPACE, SAP_WCM_NAMESPACE_ACCSTAT, SAP_WCM_NAMESPACE_COLLABORATION, SAP_WCM_NAMESPACE_EDIT, SAP_WCM_NAMESPACE_RATING, SAP_WCM_NAMESPACE_RENDERING, SECURITY_MANAGER_TYPE_ACL, SECURITY_MANAGER_TYPE_ATTACHMENT, SECURITY_MANAGER_TYPE_COLLABORATION, SECURITY_MANAGER_TYPE_W2K, SENDTO_SERVLET_PARAM_DESCRIPTION_URI, SENDTO_SERVLET_PARAMETER_DESCRIPTION, SENDTO_SERVLET_PARAMETER_RESOURCE, SENDTO_SERVLET_PARAMETER_SENDASLINK, SENDTO_SERVLET_PARAMETER_STARTPAGE, SENDTO_SERVLET_PARAMETER_SUBJECT, SENDTO_SERVLET_PARAMETER_TO, SENDTO_SERVLET_PARAMETER_XML_FILE, SENDTO_SERVLET_VALUE_FALSE, SENDTO_SERVLET_VALUE_STARTPAGE, SENDTO_SERVLET_VALUE_TRUE, SENDTO_SERVLET_VALUE_XML_FILE, SERVICE_SERVLET_ACTION_DELETE, SERVICE_SERVLET_PARAMETER_ACTION, SERVICE_SERVLET_PARAMETER_IS_GLOBAL, SERVICE_SERVLET_PARAMETER_LOCATION, SERVICE_SERVLET_PARAMETER_POPUP, SERVICE_SERVLET_PARAMETER_PREFIX, SERVICE_SERVLET_PARAMETER_REPOSITORY, SERVICE_SERVLET_PARAMETER_RESOURCE, SERVICE_SERVLET_PARAMETER_SERVICE_ID, SERVICE_SERVLET_PARAMETER_SERVICE_TYPE, SERVICE_SERVLET_PARAMETER_STARTPAGE, SERVICE_SERVLET_PARAMETER_STRING_ONE, SERVICE_SERVLET_PARAMETER_STRING_TWO, SERVICE_SERVLET_PARAMETER_SUBSCRIPTIONID, SERVICE_SERVLET_PARAMETER_XML_FILE, SERVICE_SERVLET_SUBSCRIPTIONADMINISTRATION_STARTPAGE, SERVICE_SERVLET_SUBSCRIPTIONADMINISTRATION_XML_FILE, SERVICE_SERVLET_VALUE_FALSE, SERVICE_SERVLET_VALUE_STARTPAGE, SERVICE_SERVLET_VALUE_TRUE, SERVICE_SERVLET_VALUE_XML_FILE, SHAREDSPACE_SERVICE, SHOW_CLOSE_BUTTON_PARAMETER, SORTORDERASCENDING, SORTORDERDESCENDING, STATEMANAGEMENT_SERVICE, SUBSCRIPTION_SERVICE, TIMEBASED_PUBLISH_SERVICE, USER_MAPPING_REDIRECT, VIRTUAL_ROOT_PREFIX, WASTEBASKET_SERVICE, WCM_HORIZONTAL_ALIGN_RIGHT, XSUBSCRIPTION_SERVICE

Method Summary

ILayoutSet	createLayoutSet()
boolean	deleteParametersForCollection(ICollection impCollection, ILayoutContext context)
String[]	getAllLayoutSetIDs()
ILayoutContext	getContextForUser(com.sap.security.api.IUser impUser, String ID)
IProfileList	getProfiles()
boolean	isWriteAllowed(ICollection impCollection, ILayoutContext context)
ILayoutSet	readParametersForCollection(ICollection impCollection, ILayoutContext context)
IProfile	readProfile(ICollection impCollection, ILayoutContext context)
Properties	readPropertiesForCollection(ICollection impCollection, ILayoutContext context)
boolean	saveParametersForCollection(ICollection impCollection, ILayoutSet impParameters, ILayoutContext context)
boolean	saveProfile(ICollection impCollection, IProfile impProfile, ILayoutContext context)

Methods inherited from interface com.sapportals.wcm.repository.service.IRepositoryService

acceptServletCall, getDescription, getDescription, getID, getServiceType

Field Detail

MAX_CONTEXT_LENGTH

static final int MAX_CONTEXT_LENGTH

See Also:

Constant Field Values

Method Detail

getProfiles

IProfileList getProfiles()
                         throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

getAllLayoutSetIDs

String[] getAllLayoutSetIDs()
                            throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

saveProfile

boolean saveProfile(ICollection impCollection,
                    IProfile impProfile,
                    ILayoutContext context)

readProfile

IProfile readProfile(ICollection impCollection,
                     ILayoutContext context)
                     throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

saveParametersForCollection

boolean saveParametersForCollection(ICollection impCollection,
                                    ILayoutSet impParameters,
                                    ILayoutContext context)

readParametersForCollection

ILayoutSet readParametersForCollection(ICollection impCollection,
                                       ILayoutContext context)
                                       throws LayoutServiceConfigLoadException

Throws:

LayoutServiceConfigLoadException

readPropertiesForCollection

Properties readPropertiesForCollection(ICollection impCollection,
                                       ILayoutContext context)

deleteParametersForCollection

boolean deleteParametersForCollection(ICollection impCollection,
                                      ILayoutContext context)

isWriteAllowed

boolean isWriteAllowed(ICollection impCollection,
                       ILayoutContext context)
                       throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

createLayoutSet

ILayoutSet createLayoutSet()

getContextForUser

ILayoutContext getContextForUser(com.sap.security.api.IUser impUser,
                                 String ID)
                                 throws StringToLongException

Throws:

StringToLongException

Since:

NetWeaver 7.1

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM