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 */
019
020package org.apache.isis.core.metamodel.facets.members.order;
021
022import org.apache.isis.core.metamodel.facets.MultipleValueFacet;
023import org.apache.isis.core.metamodel.facets.object.orderactions.ActionOrderFacet;
024import org.apache.isis.core.metamodel.facets.object.orderfields.FieldOrderFacet;
025
026/**
027 * The preferred mechanism for determining the order in which the members of the
028 * object should be rendered.
029 * 
030 * <p>
031 * In the standard Apache Isis Programming Model, corresponds to annotating each
032 * of the member methods with the <tt>@MemberOrder</tt>. An alternative appraoch
033 * is to use the {@link ActionOrderFacet actionOrder} or {@link FieldOrderFacet
034 * field order}.
035 * 
036 * @see MemberOrderFacet
037 * @see FieldOrderFacet
038 */
039public interface MemberOrderFacet extends MultipleValueFacet {
040
041    /**
042     * To group members.
043     */
044    public String name();
045
046    /**
047     * The sequence, in dewey-decimal notation.
048     */
049    public String sequence();
050
051}