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.collections.modify;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023import org.apache.isis.core.metamodel.facetapi.Facet;
024
025/**
026 * Clear all objects from a collection.
027 * 
028 * <p>
029 * In the standard Apache Isis Programming Model, corresponds to either invoking
030 * the <tt>clearXxx</tt> support method, or just invoking <tt>clear</tt> on the
031 * collection returned by the accessor method.
032 */
033public interface CollectionClearFacet extends Facet {
034
035    public void clear(ObjectAdapter inObject);
036}