001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019package org.apache.isis.viewer.restfulobjects.rendering.domaintypes;
020
021import org.apache.isis.core.metamodel.facets.objectvalue.maxlen.MaxLengthFacet;
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.IResourceContext;
029import org.apache.isis.viewer.restfulobjects.rendering.LinkBuilder;
030import org.apache.isis.viewer.restfulobjects.rendering.LinkFollowSpecs;
031
032public class ActionParameterDescriptionReprRenderer extends AbstractTypeFeatureReprRenderer<ActionParameterDescriptionReprRenderer, ObjectActionParameter> {
033
034    public static LinkBuilder newLinkToBuilder(final IResourceContext resourceContext, final Rel rel, final ObjectSpecification objectSpecification, final ObjectActionParameter objectActionParameter) {
035        final String domainType = objectSpecification.getSpecId().asString();
036        final ObjectAction objectAction = objectActionParameter.getAction();
037        final String actionId = objectAction.getId();
038        final String paramName = objectActionParameter.getName();
039        final String url = String.format("domain-types/%s/actions/%s/params/%s", domainType, actionId, paramName);
040        return LinkBuilder.newBuilder(resourceContext, rel.andParam("id", deriveId(objectActionParameter)), RepresentationType.ACTION_PARAMETER_DESCRIPTION, url);
041    }
042
043    public ActionParameterDescriptionReprRenderer(final IResourceContext resourceContext, final LinkFollowSpecs linkFollower, final JsonRepresentation representation) {
044        super(resourceContext, linkFollower, RepresentationType.ACTION_PARAMETER_DESCRIPTION, representation);
045    }
046
047    @Override
048    public ActionParameterDescriptionReprRenderer with(final ParentSpecAndFeature<ObjectActionParameter> specAndFeature) {
049        super.with(specAndFeature);
050
051        // done eagerly so can use as criteria for x-ro-follow-links
052        representation.mapPut("id", deriveId());
053
054        return this;
055    }
056
057    protected String deriveId() {
058        return deriveId(getObjectFeature());
059    }
060
061    private static String deriveId(final ObjectActionParameter objectActionParameter) {
062        return objectActionParameter.getAction().getId() + "-" + objectActionParameter.getName();
063    }
064
065    @Override
066    protected void addLinkSelfIfRequired() {
067        if (!includesSelf) {
068            return;
069        }
070        getLinks().arrayAdd(newLinkToBuilder(getResourceContext(), Rel.SELF, getParentSpecification(), getObjectFeature()).build());
071    }
072
073    @Override
074    protected void addLinkUpToParent() {
075        final ObjectAction parentAction = this.objectFeature.getAction();
076
077        final LinkBuilder parentLinkBuilder = ActionDescriptionReprRenderer.newLinkToBuilder(resourceContext, Rel.UP, objectSpecification, parentAction);
078        getLinks().arrayAdd(parentLinkBuilder.build());
079    }
080
081    @Override
082    protected void addPropertiesSpecificToFeature() {
083        representation.mapPut("name", getObjectFeature().getName());
084        representation.mapPut("number", getObjectFeature().getNumber());
085        representation.mapPut("optional", getObjectFeature().isOptional());
086        final MaxLengthFacet maxLength = getObjectFeature().getFacet(MaxLengthFacet.class);
087        if (maxLength != null && !maxLength.isFallback()) {
088            representation.mapPut("maxLength", maxLength.value());
089        }
090    }
091
092    @Override
093    protected void addLinksSpecificToFeature() {
094        final LinkBuilder linkBuilder = DomainTypeReprRenderer.newLinkToBuilder(resourceContext, Rel.RETURN_TYPE, objectFeature.getSpecification());
095        getLinks().arrayAdd(linkBuilder.build());
096    }
097
098    @Override
099    protected void putExtensionsSpecificToFeature() {
100        putExtensionsName();
101        putExtensionsDescriptionIfAvailable();
102    }
103
104}