001/**
002 *  Licensed to the Apache Software Foundation (ASF) under one or more
003 *  contributor license agreements.  See the NOTICE file distributed with
004 *  this work for additional information regarding copyright ownership.
005 *  The ASF licenses this file to You under the Apache License, Version 2.0
006 *  (the "License"); you may not use this file except in compliance with
007 *  the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS,
013 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 *  See the License for the specific language governing permissions and
015 *  limitations under the License.
016 */
017package org.apache.isis.viewer.restfulobjects.rendering.domaintypes;
018
019import java.util.List;
020
021import org.apache.isis.core.metamodel.facets.typeof.TypeOfFacet;
022import org.apache.isis.core.metamodel.spec.ObjectSpecification;
023import org.apache.isis.core.metamodel.spec.feature.ObjectAction;
024import org.apache.isis.core.metamodel.spec.feature.ObjectActionParameter;
025import org.apache.isis.viewer.restfulobjects.applib.JsonRepresentation;
026import org.apache.isis.viewer.restfulobjects.applib.Rel;
027import org.apache.isis.viewer.restfulobjects.applib.RepresentationType;
028import org.apache.isis.viewer.restfulobjects.rendering.LinkBuilder;
029import org.apache.isis.viewer.restfulobjects.rendering.LinkFollowSpecs;
030import org.apache.isis.viewer.restfulobjects.rendering.RendererContext;
031
032public class ActionDescriptionReprRenderer extends AbstractTypeMemberReprRenderer<ActionDescriptionReprRenderer, ObjectAction> {
033
034    public static LinkBuilder newLinkToBuilder(final RendererContext resourceContext, final Rel rel, final ObjectSpecification objectSpecification, final ObjectAction objectAction) {
035        final String domainType = objectSpecification.getSpecId().asString();
036        final String actionId = objectAction.getId();
037        final String url = "domain-types/" + domainType + "/actions/" + actionId;
038        return LinkBuilder.newBuilder(resourceContext, rel.getName(), RepresentationType.ACTION_DESCRIPTION, url);
039    }
040
041    public ActionDescriptionReprRenderer(final RendererContext resourceContext, final LinkFollowSpecs linkFollower, final JsonRepresentation representation) {
042        super(resourceContext, linkFollower, RepresentationType.ACTION_DESCRIPTION, representation);
043    }
044
045    @Override
046    protected void addLinksSpecificToFeature() {
047        addParameters();
048        addLinkToReturnTypeIfAny();
049        addLinkToElementTypeIfAny();
050    }
051
052    private void addParameters() {
053        final JsonRepresentation parameterList = JsonRepresentation.newArray();
054        final List<ObjectActionParameter> parameters = getObjectFeature().getParameters();
055        for (final ObjectActionParameter parameter : parameters) {
056            final LinkBuilder linkBuilder = ActionParameterDescriptionReprRenderer.newLinkToBuilder(getRendererContext(), Rel.ACTION_PARAM, objectSpecification, parameter);
057            parameterList.arrayAdd(linkBuilder.build());
058        }
059
060        representation.mapPut("parameters", parameterList);
061    }
062
063    protected void addLinkToElementTypeIfAny() {
064        final TypeOfFacet facet = getObjectFeature().getFacet(TypeOfFacet.class);
065        if (facet == null) {
066            return;
067        }
068        final ObjectSpecification typeOfSpec = facet.valueSpec();
069        final LinkBuilder linkBuilder = DomainTypeReprRenderer.newLinkToBuilder(getRendererContext(), Rel.ELEMENT_TYPE, typeOfSpec);
070        getLinks().arrayAdd(linkBuilder.build());
071    }
072
073    private void addLinkToReturnTypeIfAny() {
074        final ObjectSpecification returnType = getObjectFeature().getReturnType();
075        if (returnType == null) {
076            return;
077        }
078        final LinkBuilder linkBuilder = DomainTypeReprRenderer.newLinkToBuilder(getRendererContext(), Rel.RETURN_TYPE, returnType);
079        getLinks().arrayAdd(linkBuilder.build());
080    }
081
082    @Override
083    protected void putExtensionsSpecificToFeature() {
084        putExtensionsName();
085        putExtensionsDescriptionIfAvailable();
086    }
087
088}