<commit_before>/*
 *  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.
 */
package org.apache.isis.core.metamodel.consent;

import org.apache.isis.core.metamodel.interactions.InteractionContext;

/**
 * Whether an {@link InteractionContext} was invoked by the user, or is
 * by the framework/programmatic.
 */
public enum InteractionInitiatedBy {

    /**
     * must be authorized, with transactions, with publishing, with domain events
     */
    USER,

    /**
     * always authorized, with transactions, with publishing, with domain events
     */
    FRAMEWORK,

    /**
     * always authorized, no transactions, no publishing, no domain events
     */
    PASS_THROUGH;

    /**
     * @see #USER
     */
    public boolean isUser() {
        return this==USER;
    }

    /**
     * @see #PASS_THROUGH
     */
    public boolean isPassThrough() {
        return this==PASS_THROUGH;
    }

}<commit_msg>ISIS-3226: minor: javadoc and utility<commit_after>/*
 *  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.
 */
package org.apache.isis.core.metamodel.consent;

import org.apache.isis.core.metamodel.interactions.InteractionContext;

/**
 * Whether an {@link InteractionContext} was invoked by the user, or is
 * by the framework/programmatic.
 */
public enum InteractionInitiatedBy {

    /**
     * must be authorized, with transactions, with publishing, with domain events
     */
    USER,

    /**
     * always authorized, with transactions, with publishing, with domain events
     */
    FRAMEWORK,

    /**
     * always authorized, no transactions, no publishing, no domain events;
     * eg. used for serialization and de-serialization
     */
    PASS_THROUGH;

    /**
     * @see #USER
     */
    public boolean isUser() { return this==USER; }

    /**
     * @see #FRAMEWORK
     */
    public boolean isFramework() { return this==FRAMEWORK; }

    /**
     * @see #PASS_THROUGH
     */
    public boolean isPassThrough() { return this==PASS_THROUGH; }

}
{'fraction_non_alphanumeric': 0.08539709649871904, 'fraction_numerical': 0.0034158838599487617, 'mean_word_length': 2.9796149490373725, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1896091', 'n_tokens_mistral': 973, 'n_tokens_neox': 936, 'n_words': 375}