ilscipio/scipio-erp

View on GitHub
applications/content/servicedef/services_website.xml

Summary

Maintainability
Test Coverage
<!--
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
  -->

<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/services.xsd">
    <description>Content Component WebSite Services</description>
    <vendor>OFBiz</vendor>

    <!-- WebSite Services -->
    <service name="createWebSite" default-entity-name="WebSite" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSite">
        <description>Create a WebSite</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <override name="siteName" optional="false"/>
    </service>
    <service name="updateWebSite" default-entity-name="WebSite" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="updateWebSite">
        <description>Update a WebSite</description>
        <permission-service service-name="contentManagerPermission" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>

    <!-- WebSite Content Services -->
    <service name="createWebSiteContent" default-entity-name="WebSiteContent" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSiteContent">
        <description>Create a WebSite Content</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="updateWebSiteContent" default-entity-name="WebSiteContent" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="updateWebSiteContent">
        <description>Update a WebSite Content</description>
        <permission-service service-name="contentManagerPermission" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="removeWebSiteContent" default-entity-name="WebSiteContent" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="removeWebSiteContent">
        <description>Remove a WebSite Content</description>
        <permission-service service-name="contentManagerPermission" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- WebSite ContentType Services -->
    <service name="createWebSiteContentType" default-entity-name="WebSiteContentType" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSiteContentType">
        <description>Create a WebSite ContentType</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateWebSiteContentType" default-entity-name="WebSiteContentType" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="updateWebSiteContentType">
        <description>Update a WebSite ContentType</description>
        <permission-service service-name="contentManagerPermission" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="removeWebSiteContentType" default-entity-name="WebSiteContentType" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="removeWebSiteContentType">
        <description>Remove a WebSite ContentType</description>
        <permission-service service-name="contentManagerPermission" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>

    <!-- WebSite Path Alias Services -->
    <service name="createWebSitePathAlias" default-entity-name="WebSitePathAlias" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSitePathAlias">
        <description>Create a WebSite Path Alias</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="updateWebSitePathAlias" default-entity-name="WebSitePathAlias" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="updateWebSitePathAlias">
        <description>Update a WebSite Path Alias</description>
        <permission-service service-name="contentManagerPermission" main-action="UPDATE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes include="nonpk" mode="IN" optional="true"/>
    </service>
    <service name="removeWebSitePathAlias" default-entity-name="WebSitePathAlias" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="removeWebSitePathAlias">
        <description>Remove a WebSite Path Alias</description>
        <permission-service service-name="contentManagerPermission" main-action="DELETE"/>
        <auto-attributes include="pk" mode="IN" optional="false"/>
    </service>
    <service name="getWebSitePathAlias" default-entity-name="WebSitePathAlias" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="getWebSitePathAlias">
        <description>Get a WebSite Path Alias</description>
        <auto-attributes include="pk" mode="IN" optional="false"/>
        <auto-attributes mode="OUT" include="nonpk" optional="false"/>
    </service>

    <!-- WebSiteRole services -->
    <service name="webSiteRoleInterface" engine="interface">
        <description>WebSite Role Interface</description>
        <auto-attributes entity-name="WebSiteRole" include="all" mode="IN" optional="false"/>
        <override name="thruDate" optional="true"/>
        <override name="sequenceNum" optional="true"/>
    </service>

    <service name="addWebSiteRole" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSiteRole">
        <description>Add WebSite Role; NOTE: This service is being deprecated in favor of createWebSiteRole</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <implements service="webSiteRoleInterface"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="createWebSiteRole" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="createWebSiteRole">
        <description>Add WebSite Role</description>
        <permission-service service-name="contentManagerPermission" main-action="CREATE"/>
        <implements service="webSiteRoleInterface"/>
        <override name="fromDate" optional="true"/>
    </service>
    <service name="updateWebSiteRole" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="updateWebSiteRole">
        <description>Add WebSite Role</description>
        <permission-service service-name="contentManagerPermission" main-action="UPDATE"/>
        <implements service="webSiteRoleInterface"/>
    </service>
    <service name="removeWebSiteRole" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="removeWebSiteRole">
        <description>Remove WebSite Role</description>
        <permission-service service-name="contentManagerPermission" main-action="DELETE"/>
        <auto-attributes entity-name="WebSiteRole" include="pk" mode="IN" optional="false"/>
    </service>

    <!-- auto-create website content records -->
    <service name="autoCreateWebSiteContent" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="quickCreateWebSiteContent">
        <description>Auto Create Content Publish Points</description>
        <attribute name="webSiteId" type="String" mode="IN" optional="false">
            <type-validate>
                <fail-property resource="ContentErrorUiLabels" property="ContentRequiredFieldMissingWebSiteId"/>
            </type-validate>
        </attribute>
        <attribute name="webSiteContentTypeId" type="List" mode="IN" optional="false">
            <type-validate>
                <fail-property resource="ContentErrorUiLabels" property="ContentRequiredFieldMissingWebSiteContentTypeId"/>
            </type-validate>
        </attribute>
    </service>

    <service name="generateMissingSeoUrlForWebsite" engine="simple" auth="true"
            location="component://content/script/org/ofbiz/content/website/WebSiteServices.xml" invoke="generateMissingSeoUrlForWebsite" transaction-timeout="36000000">
        <description>Generate Missing Seo URL's for Website</description>
        <attribute name="webSiteId" type="String" mode="IN" optional="false">
            <type-validate>
                <fail-property resource="ContentErrorUiLabels" property="ContentRequiredFieldMissingWebSiteId"/>
            </type-validate>
        </attribute>
        <attribute name="prodCatalogId" type="String" mode="IN" optional="false">
            <type-validate>
                <fail-property resource="ContentErrorUiLabels" property="ContentRequiredFieldMissingProdCatalogId"/>
            </type-validate>
        </attribute>
        <attribute name="typeGenerate" type="List" mode="IN" optional="false">
            <type-validate>
                <fail-property resource="ContentErrorUiLabels" property="ContentRequiredFieldMissingTypeGenerate"/>
            </type-validate>
        </attribute>
    </service>
</services>